com.netegrity.policyserver.smapi
Class SAMLConfig

java.lang.Object
  |
  +--com.netegrity.policyserver.smapi.SAMLConfig

public class SAMLConfig

extends java.lang.Object

The SAMLConfig class facilitates getting Service Provider and Identity Provider properties through Policy Server native implementation.

Constructor Summary

SAMLConfig()

Method Summary

int	addAssertionConsumerServicetoSP(java.lang.String SAMLSPOid, java.lang.String[] SAMLSPAssertionConSvcs) this method uses the PM API, therefore it requires a session to be established first
int	addSAMLIdentityProvider(java.util.HashMap IDPinfo) This method adds a given SAML Identity Provider.
int	addSAMLServiceProvider(java.lang.String AffiliateDomain, java.util.HashMap SPinfo) This method adds a given SAML Service Provider.
int	getAffiliatedIdentityProviders(java.lang.String affiliation, java.lang.String[] providers) Gets an array of OIDs of Identity Providers that belong to a given SAML Affiliation.
int	getAffiliatedProviders(java.lang.String affiliation, java.lang.String[] providers) Gets an array of OIDs of providers that belong to a given SAML Affiliation.
int	getAffiliatedServiceProviders(java.lang.String affiliation, java.lang.String[] providers) Gets an array of OIDs of Service Providers that belong to a given SAML Affiliation.
SAMLAffiliationInfo	getAffiliationById(java.lang.String affiliationId, java.lang.String[] namesToGet) Gets SAMLAffiliationInfo class for the given affiliation ID.
SAMLAffiliationInfo	getAffiliationByOid(java.lang.String oid, java.lang.String[] namesToGet) Gets SAMLAffiliationInfo class for the given affiliation OID.
SAMLIdentityProviderInfo	getIdentityProviderById(java.lang.String providerId, java.lang.String[] namesToGet) Gets SAMLIdentityProviderInfo class for the given provider ID.
SAMLIdentityProviderInfo	getIdentityProviderByName(java.lang.String providerName) Gets Identity Provider configuration for a given Identity Provider.
SAMLIdentityProviderInfo	getIdentityProviderByOid(java.lang.String oid, java.lang.String[] namesToGet) Gets SAMLIdentityProviderInfo class for the given provider OID.
SAMLIdentityProviderInfo	getIdentityProviderBySourceId(java.lang.String sourceId, java.lang.String[] namesToGet) Gets SAMLIdentityProviderInfo class for the given provider source ID.
SAMLAffiliateInfo	getSAMLAffiliateByID(java.lang.String providerID, java.lang.String[] namesToGet) Gets SAMLAffiliateInfo class for the given SAML Affiliate object's consumer ID.
SAMLAffiliateInfo	getSAMLAffiliateByName(java.lang.String name, java.lang.String[] namesToGet) Gets SAMLAffiliateInfo class for the given SAML Affiliate object name.
SAMLConsumerInfo	getSAMLConsumerByID(java.lang.String providerId, java.lang.String[] namesToGet) Gets SAMLConsumerInfo class for the given producer ID.
SAMLConsumerInfo	getSAMLConsumerByOid(java.lang.String oid, java.lang.String[] namesToGet) Gets SAMLConsumerInfo class for the given consumer OID.
SAMLConsumerInfo	getSAMLConsumerBySrcID(java.lang.String srcID, java.lang.String[] namesToGet) Gets SAMLConsumerInfo class for the given Source ID.
SAMLServiceProviderInfo	getServiceProviderById(java.lang.String providerId, java.lang.String[] namesToGet) Gets SAMLServiceProviderInfo class for the given provider ID.
SAMLServiceProviderInfo	getServiceProviderByName(java.lang.String providerName) Gets SAMLServiceProviderInfo class for the given provider name.
SAMLServiceProviderInfo	getServiceProviderByOid(java.lang.String oid, java.lang.String[] namesToGet) Gets SAMLServiceProviderInfo class for the given provider OID.
int	PolicyAPILogin(java.lang.String UserName, java.lang.String Password) This method calls the underlying C Policy API Sm_PolicyApi_Login for Policy API login using the SiteMinder administrator credentials
boolean	PolicyAPILogout() This method calls the underlying C Policy API Sm_PolicyApi_Logout for log out of an administrator session

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SAMLConfig

public SAMLConfig()

Method Detail

PolicyAPILogin

public int PolicyAPILogin(java.lang.String UserName,
                          java.lang.String Password)
                   throws NativeCallbackError

This method calls the underlying C Policy API Sm_PolicyApi_Login for Policy API login using the SiteMinder administrator credentials

Parameters:

UserName - The SiteMinder administrator name

Password - The SiteMinder administrator password

Returns:

0 in case the login is successful Negative error code in case the login failed

Throws:

NativeCallbackError - in case an error was encountered during login

PolicyAPILogout

public boolean PolicyAPILogout()
                        throws NativeCallbackError

This method calls the underlying C Policy API Sm_PolicyApi_Logout for log out of an administrator session

Returns:

true in case the logout is successful false otherwise

Throws:

NativeCallbackError - in case an error was encountered during logout

getServiceProviderById

public SAMLServiceProviderInfo getServiceProviderById(java.lang.String providerId,
                                                      java.lang.String[] namesToGet)
                                               throws NativeCallbackError

Gets SAMLServiceProviderInfo class for the given provider ID.

Parameters:

providerId - The service provider ID.

namesToGet - The names of the properties to get.

Returns:

The provider info object, or null in case of error or if no data is found.

NativeCallbackError

getServiceProviderByName

public SAMLServiceProviderInfo getServiceProviderByName(java.lang.String providerName)
                                                 throws NativeCallbackError

Gets SAMLServiceProviderInfo class for the given provider name. this method uses the PM API, therefore it requires a session to be established first

Parameters:

providerName - The SiteMinder name of the service provider.

Returns:

The service provider info or null in case no data is found. If the Administrator does not have permissions to manage system or domain objects, the SAMLServiceProviderInfo is returned with a single property called "NoPrivilege" - the value stored is irrelevent.

NativeCallbackError

getServiceProviderByOid

public SAMLServiceProviderInfo getServiceProviderByOid(java.lang.String oid,
                                                       java.lang.String[] namesToGet)
                                                throws NativeCallbackError

Gets SAMLServiceProviderInfo class for the given provider OID.

Parameters:

oid - The identity provider OID.

namesToGet - The names of the properties to get.

Returns:

The provider info object, or null in case of error or if no data is found.

NativeCallbackError

addSAMLServiceProvider

public int addSAMLServiceProvider(java.lang.String AffiliateDomain,
                                  java.util.HashMap SPinfo)
                           throws NativeCallbackError

This method adds a given SAML Service Provider. this method uses the PM API, therefore it requires a session to be established first

Parameters:

AffiliateDomain - The name of the Affiliate Domain

SPinfo - The configuration of the Service Provider

Returns:

0 if the Service Provider was added successfully Else negative error code from the underlying C layer

NativeCallbackError

getIdentityProviderById

public SAMLIdentityProviderInfo getIdentityProviderById(java.lang.String providerId,
                                                        java.lang.String[] namesToGet)
                                                 throws NativeCallbackError

Gets SAMLIdentityProviderInfo class for the given provider ID.

Parameters:

providerId - The identity provider ID.

namesToGet - The names of the properties to get.

Returns:

The provider info object, or null in case of error or if no data is found.

NativeCallbackError

getIdentityProviderByName

public SAMLIdentityProviderInfo getIdentityProviderByName(java.lang.String providerName)
                                                   throws NativeCallbackError

Gets Identity Provider configuration for a given Identity Provider. this method uses the PM API, therefore it requires a session to be established first

Parameters:

providerName - The name of the Identity Provider.

Returns:

The Identity Provider configuration, or null in case of error or if no data is found.

NativeCallbackError

addSAMLIdentityProvider

public int addSAMLIdentityProvider(java.util.HashMap IDPinfo)
                            throws NativeCallbackError

This method adds a given SAML Identity Provider. this method uses the PM API, therefore it requires a session to be established first

Returns:

0 if the Service Provider was added successfully Else negative error code from the underlying C layer

NativeCallbackError

addAssertionConsumerServicetoSP

public int addAssertionConsumerServicetoSP(java.lang.String SAMLSPOid,
                                           java.lang.String[] SAMLSPAssertionConSvcs)
                                    throws NativeCallbackError

this method uses the PM API, therefore it requires a session to be established first

Parameters:

SAMLSPOid -

SAMLSPAssertionConSvcs -

Returns:

Throws:

NativeCallbackError

getIdentityProviderBySourceId

public SAMLIdentityProviderInfo getIdentityProviderBySourceId(java.lang.String sourceId,
                                                              java.lang.String[] namesToGet)
                                                       throws NativeCallbackError

Gets SAMLIdentityProviderInfo class for the given provider source ID.

Parameters:

sourceId - The identity provider source ID.

namesToGet - The names of the properties to get.

Returns:

The provider info object, or null in case of error or if no data is found. If the Administrator does not have permission to manage system or domain objects, the SAMLIdentityProviderInfo is returned with a single property called "NoPrivilege" - the value stored is irrelevent.

NativeCallbackError

getIdentityProviderByOid

public SAMLIdentityProviderInfo getIdentityProviderByOid(java.lang.String oid,
                                                         java.lang.String[] namesToGet)
                                                  throws NativeCallbackError

Gets SAMLIdentityProviderInfo class for the given provider OID.

Parameters:

oid - The provider OID.

namesToGet - The names of the properties to get.

Returns:

The provider info object, or null in case of error or if no data is found.

NativeCallbackError

getAffiliationById

public SAMLAffiliationInfo getAffiliationById(java.lang.String affiliationId,
                                              java.lang.String[] namesToGet)
                                       throws NativeCallbackError

Gets SAMLAffiliationInfo class for the given affiliation ID.

Parameters:

affiliationId - The affiliation ID.

namesToGet - The names of the properties to get.

Returns:

The affiliation info object, or null in case of error or if no data is found.

NativeCallbackError

getAffiliationByOid

public SAMLAffiliationInfo getAffiliationByOid(java.lang.String oid,
                                               java.lang.String[] namesToGet)
                                        throws NativeCallbackError

Gets SAMLAffiliationInfo class for the given affiliation OID.

Parameters:

oid - The affiliation OID.

namesToGet - The names of the properties to get.

Returns:

The provider info object, or null in case of error or if no data is found.

NativeCallbackError

getAffiliatedServiceProviders

public int getAffiliatedServiceProviders(java.lang.String affiliation,
                                         java.lang.String[] providers)

Gets an array of OIDs of Service Providers that belong to a given SAML Affiliation.

Parameters:

affiliation - The affiliation OID.

providers - The OIDs of the Service Providers (a partial list, if there are more than the size of the allocated array).

Returns:

The total number of providers (may be more than the size of the allocated array), or -1 in case of error.

getAffiliatedIdentityProviders

public int getAffiliatedIdentityProviders(java.lang.String affiliation,
                                          java.lang.String[] providers)

Gets an array of OIDs of Identity Providers that belong to a given SAML Affiliation.

Parameters:

affiliation - The affiliation OID.

providers - The OIDs of the Identity Providers (a partial list, if there are more than the size of the allocated array).

Returns:

The total number of providers (may be more than the size of the allocated array), or -1 in case of error.

getAffiliatedProviders

public int getAffiliatedProviders(java.lang.String affiliation,
                                  java.lang.String[] providers)

Gets an array of OIDs of providers that belong to a given SAML Affiliation.

Parameters:

affiliation - The affiliation OID.

providers - The OIDs of the providers (a partial list, if there are more than the size of the allocated array).

Returns:

The total number of providers (may be more than the size of the allocated array), or -1 in case of error.

getSAMLConsumerByOid

public SAMLConsumerInfo getSAMLConsumerByOid(java.lang.String oid,
                                             java.lang.String[] namesToGet)
                                      throws NativeCallbackError

Gets SAMLConsumerInfo class for the given consumer OID.

Parameters:

oid - The identity provider OID.

namesToGet - The names of the properties to get.

Returns:

The consumer info object, or null in case of error or if no data is found.

Throws:

NativeCallbackError - if native callGetProviderByOid() fails.

getSAMLConsumerByID

public SAMLConsumerInfo getSAMLConsumerByID(java.lang.String providerId,
                                            java.lang.String[] namesToGet)
                                     throws NativeCallbackError

Gets SAMLConsumerInfo class for the given producer ID.

Parameters:

providerId - The Producer's ID.

namesToGet - The names of the properties to get.

Returns:

The provider info object, or null in case of error or if no data is found.

NativeCallbackError

getSAMLConsumerBySrcID

public SAMLConsumerInfo getSAMLConsumerBySrcID(java.lang.String srcID,
                                               java.lang.String[] namesToGet)
                                        throws NativeCallbackError

Gets SAMLConsumerInfo class for the given Source ID.

Parameters:

srcID - The Producer's Source ID.

namesToGet - The names of the properties to get.

Returns:

The provider info object, or null in case of error or if no data is found.

NativeCallbackError

getSAMLAffiliateByName

public SAMLAffiliateInfo getSAMLAffiliateByName(java.lang.String name,
                                                java.lang.String[] namesToGet)
                                         throws NativeCallbackError

Gets SAMLAffiliateInfo class for the given SAML Affiliate object name.

Parameters:

name - SAML Affiliate object name.

namesToGet - The names of the properties to get.

Returns:

The Affiliate info object, or null in case of error or if no data is found.

Throws:

NativeCallbackError - if native callGetAffiliateByName() fails.

getSAMLAffiliateByID

public SAMLAffiliateInfo getSAMLAffiliateByID(java.lang.String providerID,
                                              java.lang.String[] namesToGet)
                                       throws NativeCallbackError

Gets SAMLAffiliateInfo class for the given SAML Affiliate object's consumer ID.

Parameters:

providerID - Consumer ID of SAML Affiliate object.

namesToGet - The names of the properties to get.

Returns:

The Affiliate info object, or null in case of error or if no data is found.

Throws:

NativeCallbackError - if native callGetAffiliateByID() fails.