com.crystaldecisions.sdk.plugin.desktop.samlserviceprovider
Interface ISAMLServiceProviderBase

All Known Subinterfaces:

ISAMLServiceProvider

public interface ISAMLServiceProviderBase

This interface inherits from IInfoObject and ISAMLServiceProviderBase. It allows you to configure a SAML Service Provider in order to generate SAML tickets for single sign on. Tickets may be generated using the SecurityTokenService from the PJS.

Field Summary

static java.lang.String	KIND The Kind used to query for SAMLServiceProvider objects.
static java.lang.String	PROGID The ProgID for the SAMLServiceProvider Class.
static java.lang.String	ROOT_FOLDER_CUID

Method Summary

java.lang.String	generateIdPBase64Certificate()
java.lang.String	getFormattedIdPBase64Certificate()
java.lang.String	getIdPBase64Certificate()
java.lang.String	getIdPID() Returns the identity provide id that the service provider recognizes tickets from
java.lang.String	getSiteUrl()
java.lang.String	getSpAcsUrl()
java.lang.String	getSpHost()
java.lang.String	getSpID()
int	getSpPort()
java.lang.String	getSpSloUrl()
boolean	hasIdPCertificate()
void	setIdPID(java.lang.String newId)
void	setSiteUrl(java.lang.String siteUrl)
void	setSpAcsUrl(java.lang.String acsUrl)
void	setSpHost(java.lang.String host)
void	setSpID(java.lang.String spId)
void	setSpPort(int port)
void	setSpSloUrl(java.lang.String sloUrl)

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for SAMLServiceProvider objects.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the SAMLServiceProvider Class.

ProgID	CrystalEnterprise.SAMLServiceProvider
Query Category	CI_SYSTEMOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.desktop.samlserviceprovider.ISAMLServiceProvider

Query syntax:

SELECT
	*
FROM
	CI_SYSTEMOBJECTS
WHERE
	SI_PROGID='CrystalEnterprise.SAMLServiceProvider'

The CePropertyIDs named in the SELECT statement are those that are required to access data through the ISAMLServiceProvider interface. For more information on their associations with the interface's methods, see ISAMLServiceProvider

See Also:

Constant Field Values

ROOT_FOLDER_CUID

static final java.lang.String ROOT_FOLDER_CUID

See Also:

Constant Field Values

Method Detail

getIdPID

java.lang.String getIdPID()

Returns the identity provide id that the service provider recognizes tickets from

Returns:

The identity provider name that the SAML service provider recognizes.

InfoObject properties to query for:

SI_IDENTITY_PROVIDER_ID

setIdPID

void setIdPID(java.lang.String newId)

getSpHost

java.lang.String getSpHost()
                           throws SDKException

Throws:

SDKException

setSpHost

void setSpHost(java.lang.String host)
               throws SDKException

Throws:

SDKException

getSpPort

int getSpPort()
              throws SDKException

Throws:

SDKException

setSpPort

void setSpPort(int port)
               throws SDKException

Throws:

SDKException

hasIdPCertificate

boolean hasIdPCertificate()

getIdPBase64Certificate

java.lang.String getIdPBase64Certificate()
                                         throws SDKException

Throws:

SDKException

getFormattedIdPBase64Certificate

java.lang.String getFormattedIdPBase64Certificate()
                                                  throws SDKException

Throws:

SDKException

generateIdPBase64Certificate

java.lang.String generateIdPBase64Certificate()
                                              throws SDKException

Throws:

SDKException

getSpID

java.lang.String getSpID()
                         throws SDKException

Throws:

SDKException

setSpID

void setSpID(java.lang.String spId)
             throws SDKException

Throws:

SDKException

getSpAcsUrl

java.lang.String getSpAcsUrl()
                             throws SDKException

Throws:

SDKException

setSpAcsUrl

void setSpAcsUrl(java.lang.String acsUrl)
                 throws SDKException

Throws:

SDKException

getSpSloUrl

java.lang.String getSpSloUrl()
                             throws SDKException

Throws:

SDKException

setSpSloUrl

void setSpSloUrl(java.lang.String sloUrl)
                 throws SDKException

Throws:

SDKException

getSiteUrl

java.lang.String getSiteUrl()
                            throws SDKException

Throws:

SDKException

setSiteUrl

void setSiteUrl(java.lang.String siteUrl)
                throws SDKException

Throws:

SDKException