com.businessobjects.sdk.plugin.desktop.streamworkintegration
Interface IStreamWorkIntegrationBase

All Known Subinterfaces:

IStreamWorkIntegration

public interface IStreamWorkIntegrationBase

Interface for StreamWork Integration Configuration object

Since:

4.1

Field Summary

static java.lang.String	KIND The Kind used to query for StreamWork Integration Configuration
static java.lang.String	PROGID CrystalEnterprise.StreamWorkIntegration

Method Summary

java.lang.String	generateIdPBase64Certificate() Generate a new certificate for current idp
java.lang.String	getHttpProxyHost() Get the http(s) proxy host name
int	getHttpProxyPort() Get the http(s) proxy port number
java.lang.String	getIdPBase64Certificate() Get the certificate of the current idp
java.lang.String	getIdPID() Get the BOE Identity Provider ID
boolean	getIntegrationEnabled() Check if the StreamWork integration is enabled
boolean	getJamIntegrationEnabled() Check if the Jam integration is enabled
java.lang.String	getOAuthConsumerKey() Get the consumer key of the OAuth application
java.lang.String	getSiteUrl() Get the StreamWork site url
java.lang.String	getSpAcsUrl() Get the StreamWork sp acs url
java.lang.String	getSpID() Get the StreamWork sp id
java.lang.String	getSpSloUrl() Get the StreamWork sp slo url
boolean	hasIdPCertificate()
boolean	isHttpProxyEnabled() Check if a http proxy settings will be used when connect to StreamWork
void	setHttpProxyEnabled(boolean bEnabled) Set the StreamWork http proxy state
void	setHttpProxyHost(java.lang.String host) Set the http(s) proxy host name
void	setHttpProxyPort(int port) Set the http(s) proxy port number
void	setIdPID(java.lang.String idpID) Set the BOE Identity Provider ID
void	setIntegrationEnabled(boolean bEnabled) Set the StreamWork integration state
void	setJamIntegrationEnabled(boolean enableJam) Set the Jam integration state
void	setOAuthConsumerKey(java.lang.String key) Set the consumer key of the OAuth application
void	setSiteUrl(java.lang.String siteUrl) Set the StreamWork site url
void	setSpAcsUrl(java.lang.String acsUrl) Set the StreamWork sp acs url
void	setSpID(java.lang.String spId) Set the StreamWork sp id
void	setSpSloUrl(java.lang.String sloUrl) Set the StreamWork sp

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for StreamWork Integration Configuration

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

CrystalEnterprise.StreamWorkIntegration

See Also:

Constant Field Values

Method Detail

hasIdPCertificate

boolean hasIdPCertificate()

InfoObject properties to query for:

SI_IDP_CERTIFICATE

getIdPBase64Certificate

java.lang.String getIdPBase64Certificate()
                                         throws SDKException

Get the certificate of the current idp

Returns:

A String contains based64 encoded certificate

Throws:

SDKException - if the corresponding property is not found

InfoObject properties to query for:

SI_IDP_CERTIFICATE

generateIdPBase64Certificate

java.lang.String generateIdPBase64Certificate()
                                              throws SDKException

Generate a new certificate for current idp

Returns:

A String contains the newly generated certificate

Throws:

SDKException - if there is an error during the certificate generation

getIdPID

java.lang.String getIdPID()
                          throws SDKException

Get the BOE Identity Provider ID

Returns:

A String contains the BOE Identity Provider ID

Throws:

SDKException - if the corresponding property is not found

InfoObject properties to query for:

SI_IDP_ID

setIdPID

void setIdPID(java.lang.String idpID)
              throws SDKException

Set the BOE Identity Provider ID

Parameters:

appKey - the value of the Identity Provider ID

Throws:

SDKException - if the value is null or empty

getSpID

java.lang.String getSpID()
                         throws SDKException

Get the StreamWork sp id

Returns:

A String contains the sp id

Throws:

SDKException - if the corresponding property is not found

InfoObject properties to query for:

SI_SP_ID

setSpID

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

Set the StreamWork sp id

Parameters:

spId - the value of the StreamWork sp id

Throws:

SDKException - if the value is null or empty

InfoObject properties to query for:

SI_SP_ID

getSpAcsUrl

java.lang.String getSpAcsUrl()
                             throws SDKException

Get the StreamWork sp acs url

Returns:

A String contains the sp acs url

Throws:

SDKException - if the corresponding property is not found

InfoObject properties to query for:

SI_SP_ACS_URL

setSpAcsUrl

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

Set the StreamWork sp acs url

Parameters:

acsUrl - the value of the StreamWork sp acs url

Throws:

SDKException - if the value is null or empty

InfoObject properties to query for:

SI_SP_ACS_URL

getSpSloUrl

java.lang.String getSpSloUrl()
                             throws SDKException

Get the StreamWork sp slo url

Returns:

A String contains the sp slo url

Throws:

SDKException - if the corresponding property is not found

InfoObject properties to query for:

SI_SP_SLO_URL

setSpSloUrl

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

Set the StreamWork sp

Parameters:

sloUrl - the value of the StreamWork sp slo url

Throws:

SDKException - if the value is null or empty

InfoObject properties to query for:

SI_SP_SLO_URL

getSiteUrl

java.lang.String getSiteUrl()
                            throws SDKException

Get the StreamWork site url

Returns:

A String contains the site url

Throws:

SDKException - if the corresponding property is not found

InfoObject properties to query for:

SI_SITE_URL

setSiteUrl

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

Set the StreamWork site url

Parameters:

siteUrl - the value of the StreamWork site url

Throws:

SDKException - if the value is null or empty

InfoObject properties to query for:

SI_SITE_URL

getIntegrationEnabled

boolean getIntegrationEnabled()
                              throws SDKException

Check if the StreamWork integration is enabled

Returns:

A boolean indicates if integration to SteamWork is enabled

Throws:

SDKException - if the corresponding property is not found

InfoObject properties to query for:

SI_ENABLED

setIntegrationEnabled

void setIntegrationEnabled(boolean bEnabled)

Set the StreamWork integration state

Parameters:

bEnabled - - the value of the integration state

InfoObject properties to query for:

SI_ENABLED

getJamIntegrationEnabled

boolean getJamIntegrationEnabled()
                                 throws SDKException

Check if the Jam integration is enabled

Returns:

A boolean indicates if integration to Jam is enabled

Throws:

SDKException - if the corresponding property is not found

setJamIntegrationEnabled

void setJamIntegrationEnabled(boolean enableJam)

Set the Jam integration state

Parameters:

enableJam - the value of the integration state

InfoObject properties to query for:

SI_ENABLE_JAM

isHttpProxyEnabled

boolean isHttpProxyEnabled()

Check if a http proxy settings will be used when connect to StreamWork

Returns:

A boolean indicates if proxy settings are enabled, return false if the corresponding property is not found

InfoObject properties to query for:

SI_HTTP_PROXY_ENABLED

setHttpProxyEnabled

void setHttpProxyEnabled(boolean bEnabled)

Set the StreamWork http proxy state

Parameters:

bEnabled - - the value of the http proxy state

InfoObject properties to query for:

SI_HTTP_PROXY_ENABLED

getHttpProxyHost

java.lang.String getHttpProxyHost()
                                  throws SDKException

Get the http(s) proxy host name

Returns:

A String contains the proxy host name

Throws:

SDKException - if the corresponding property is not found

InfoObject properties to query for:

SI_HTTP_PROXY_HOST

setHttpProxyHost

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

Set the http(s) proxy host name

Parameters:

host - - the value of the proxy host name

Throws:

SDKException - if the value is null or empty

InfoObject properties to query for:

SI_HTTP_PROXY_HOST

getHttpProxyPort

int getHttpProxyPort()
                     throws SDKException

Get the http(s) proxy port number

Returns:

A int contains the proxy port number

Throws:

SDKException - if the corresponding property is not found

InfoObject properties to query for:

SI_HTTP_PROXY_PORT

setHttpProxyPort

void setHttpProxyPort(int port)
                      throws SDKException

Set the http(s) proxy port number

Parameters:

port - - the value of the proxy port number

Throws:

SDKException - if the value is null or empty

InfoObject properties to query for:

SI_HTTP_PROXY_PORT

getOAuthConsumerKey

java.lang.String getOAuthConsumerKey()
                                     throws SDKException

Get the consumer key of the OAuth application

Returns:

A String contains the consumer key value

Throws:

SDKException - if the corresponding property is not found

InfoObject properties to query for:

SI_CONSUMER_KEY

setOAuthConsumerKey

void setOAuthConsumerKey(java.lang.String key)
                         throws SDKException

Set the consumer key of the OAuth application

Parameters:

key - - the value of the consumer key

Throws:

SDKException - if the value is null or empty

InfoObject properties to query for:

SI_CONSUMER_KEY