com.crystaldecisions.sdk.plugin.authentication.sap
Interface IsecSAPR3

All Superinterfaces:

IInfoObject, ISAPR3LogicalSystemsHelper, IsecAttributeBinding, IsecCommitAction

public interface IsecSAPR3
extends IInfoObject, IsecCommitAction, IsecAttributeBinding, ISAPR3LogicalSystemsHelper

Nested Class Summary

Nested classes/interfaces inherited from interface com.crystaldecisions.sdk.occa.infostore.IInfoObject

IInfoObject.CommitLevel, IInfoObject.Delta, IInfoObject.LocaleOption, IInfoObject.LockStatus, IInfoObject.PropertySet

Nested classes/interfaces inherited from interface com.crystaldecisions.sdk.plugin.authentication.common.IsecCommitAction

IsecCommitAction.CommitActionType

Field Summary

static java.lang.String	CUID The CUID associated with the secSAPR3 authentication plugin.
static java.lang.String	KIND The Kind used to query for the secSAPR3 interface.
static java.lang.String	PROGID The ProgID for the secSAPR3 interface.

Method Summary

java.lang.String	getContentRoot()
java.lang.String	getDefaultSystem()
java.lang.String	getDefaultUserLicenseRestrictionCUID()
java.lang.String	getDisabledSystems()
java.lang.String	getEntitlementSystems()
java.lang.String	getMappedGroups()
java.lang.String[]	getMappedGroupsArray()
int	getMaxConnections()
int	getMaxFail()
int	getMaxUsage()
int	getRetryInterval()
java.lang.String	getSNCIdentity()
java.lang.String	getSNCLibPath()
java.lang.String	getSNCLibPathDefault() Retrieve the default SNC library path.
java.lang.String	getSNCMode()
java.lang.String	getSNCQop()
java.lang.String	getSNCTrustedSystems()
java.lang.String	getSSO2DBKeyAlias() gets the key alias
java.lang.String	getSSO2DBKeyPassword() Gets the key password
java.lang.String	getSSO2DBKeystore() Get the base64 encoded keystore used for SSO
java.lang.String	getSSO2DBKeystorePassword() Gets the keystore password
java.lang.String	getSSO2DBSystemID() Return the System ID used to identify this BOE system to the rest of the SAP landscape.
boolean	isCreateNamedUsers()
boolean	isMasterAvail()
boolean	isSSO2DBKeyPasswordBlank() Returns true if the key password is blank, or doesn't exist yet.
boolean	isSSO2DBKeystorePasswordBlank() Returns true if the keystore password is blank, or doesn't exist yet.
boolean	isSynchronizeUsers()
boolean	isUpdateUsers()
void	setContentRoot(java.lang.String contentRoot)
void	setCreateNamedUsers(boolean createNamedUsers)
void	setDefaultSystem(java.lang.String defaultSystem)
void	setDefaultUserLicenseRestrictionCUID(java.lang.String licenseRestrictionCuid)
void	setDisabledSystems(java.lang.String disabledSystems)
void	setEntitlementSystems(java.lang.String entitlementSystems)
void	setMappedGroups(java.lang.String mappedGroups)
void	setMappedGroupsArray(java.lang.String[] mappedGroups)
void	setMasterAvail(boolean masterAvail)
void	setMaxConnections(int maxConnections)
void	setMaxFail(int maxFail)
void	setMaxUsage(int maxUsage)
void	setRetryInterval(int retryInterval)
void	setSNCIdentity(java.lang.String sncIdentity)
void	setSNCLibPath(java.lang.String sncLibPath)
void	setSNCMode(java.lang.String sncMode)
void	setSNCQop(java.lang.String sncQop)
void	setSNCTrustedSystems(java.lang.String sncTrustedSystems)
void	setSSO2DBKeyAlias(java.lang.String keyAlias) Sets the key alias
void	setSSO2DBKeyPassword(java.lang.String keyPassword) Sets the key password
void	setSSO2DBKeystore(java.lang.String keystore) Set the keystore that will be used for SSO
void	setSSO2DBKeystorePassword(java.lang.String storePassword) Sets the keystore password
void	setSSO2DBSystemID(java.lang.String systemID) Set the System ID used to identify this BOE system to the rest of the SAP landscape.
void	setSynchronizeUsers(boolean synchronizeUsers)
void	setUpdateUsers(boolean updateUsers)

Methods inherited from interface com.crystaldecisions.sdk.occa.infostore.IInfoObject

applyDelta, applyDelta, clearTenantID, deleteNow, getCommitLevel, getCUID, getDelta, getDelta, getDescription, getDescription, getDescription, getDescriptionLocales, getFileLocales, getFiles, getFiles, getGUID, getID, getKeyword, getKind, getLockInfo, getOwner, getOwnerID, getParent, getParent, getParentCUID, getParentID, getProcessingInfo, getProgID, getRUID, getSchedulingInfo, getSecurityInfo, getSecurityInfo2, getSourceFiles, getSpecificKind, getSpecificProgID, getTenantID, getTitle, getTitle, getTitle, getTitleLocales, getUpdateTimeStamp, isDirty, isInstance, isLockHeld, isMarkedAsRead, isReadOnly, properties, propertyIDs, releaseLock, removeFiles, removeSourceFiles, retrievePropertySet, save, setCommitLevel, setDescription, setKeyword, setMarkedAsRead, setParentID, setTenantID, setTitle, unlockNow

Methods inherited from interface com.crystaldecisions.sdk.plugin.authentication.common.IsecCommitAction

getPluginCommitActionConfig, setPluginCommitAction, setPluginCommitActionConfig

Methods inherited from interface com.crystaldecisions.sdk.plugin.authentication.common.IsecAttributeBinding

getAttributeBindingPriority, isAttributeBindingEnabled, setAttributeBindingEnabled, setAttributeBindingPriority

Methods inherited from interface com.crystaldecisions.sdk.plugin.authentication.sap.ISAPR3LogicalSystemsHelper

getLogicalSystems, updateMappedUserGroups

Field Detail

CUID

static final java.lang.String CUID

The CUID associated with the secSAPR3 authentication plugin.

Since:

4.1

See Also:

Constant Field Values

KIND

static final java.lang.String KIND

The Kind used to query for the secSAPR3 interface.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the secSAPR3 interface.

See Also:

Constant Field Values

Method Detail

getContentRoot

java.lang.String getContentRoot()

InfoObject properties to query for:

SI_AUTH_CONTENT_ROOT

getDefaultSystem

java.lang.String getDefaultSystem()

InfoObject properties to query for:

SAP_DEFAULTSYSTEM

getDisabledSystems

java.lang.String getDisabledSystems()

InfoObject properties to query for:

SAP_DISABLED_SYSTEMS

getEntitlementSystems

java.lang.String getEntitlementSystems()

InfoObject properties to query for:

SAP_ENTITLEMENTSYSTEMS

getMappedGroups

java.lang.String getMappedGroups()

InfoObject properties to query for:

SI_MAPPED_GROUPS

getMappedGroupsArray

java.lang.String[] getMappedGroupsArray()

InfoObject properties to query for:

SI_MAPPED_GROUPS

getMaxConnections

int getMaxConnections()

InfoObject properties to query for:

SI_AUTH_MAX_CONNECTIONS

getMaxFail

int getMaxFail()

InfoObject properties to query for:

SI_AUTH_MAX_FAILURES

getMaxUsage

int getMaxUsage()

InfoObject properties to query for:

SI_AUTH_CONNECTION_USAGE

getRetryInterval

int getRetryInterval()

InfoObject properties to query for:

SI_AUTH_RETRY_INTERVAL

getSNCIdentity

java.lang.String getSNCIdentity()

InfoObject properties to query for:

SNC_IDENTITY

getSNCLibPath

java.lang.String getSNCLibPath()

InfoObject properties to query for:

SNC_LIBPATH

getSNCLibPathDefault

java.lang.String getSNCLibPathDefault()

Retrieve the default SNC library path. This value is only available only when the secSAPR3 plugin has been committed to the CMS at least once and explicitly queried for. The value returned here is exactly the value stored in the property bag. This means that you likely need to unescape it before using it.

Since:

4.1

InfoObject properties to query for:

SNC_LIBPATH_DEFAULT

getSNCMode

java.lang.String getSNCMode()

InfoObject properties to query for:

SNC_MODE

getSNCQop

java.lang.String getSNCQop()

InfoObject properties to query for:

SNC_QOP

getSNCTrustedSystems

java.lang.String getSNCTrustedSystems()

InfoObject properties to query for:

SNC_TRUSTED_SYSTEMS

isCreateNamedUsers

boolean isCreateNamedUsers()

InfoObject properties to query for:

SI_CREATE_NAMEDUSERS

getDefaultUserLicenseRestrictionCUID

java.lang.String getDefaultUserLicenseRestrictionCUID()

InfoObject properties to query for:

SI_DEFAULT_THIRDPARTY_USER_LICENSE

setDefaultUserLicenseRestrictionCUID

void setDefaultUserLicenseRestrictionCUID(java.lang.String licenseRestrictionCuid)

isMasterAvail

boolean isMasterAvail()

InfoObject properties to query for:

SI_AVAIL

isSynchronizeUsers

boolean isSynchronizeUsers()

InfoObject properties to query for:

SI_IMPORT_USERS

isUpdateUsers

boolean isUpdateUsers()

InfoObject properties to query for:

SI_SAP_UPDATE_USERS

setContentRoot

void setContentRoot(java.lang.String contentRoot)

setCreateNamedUsers

void setCreateNamedUsers(boolean createNamedUsers)

setDefaultSystem

void setDefaultSystem(java.lang.String defaultSystem)

setDisabledSystems

void setDisabledSystems(java.lang.String disabledSystems)

setEntitlementSystems

void setEntitlementSystems(java.lang.String entitlementSystems)

setMappedGroups

void setMappedGroups(java.lang.String mappedGroups)

setMappedGroupsArray

void setMappedGroupsArray(java.lang.String[] mappedGroups)

setMasterAvail

void setMasterAvail(boolean masterAvail)

setMaxConnections

void setMaxConnections(int maxConnections)

setMaxFail

void setMaxFail(int maxFail)

setMaxUsage

void setMaxUsage(int maxUsage)

setRetryInterval

void setRetryInterval(int retryInterval)

setSNCIdentity

void setSNCIdentity(java.lang.String sncIdentity)

setSNCLibPath

void setSNCLibPath(java.lang.String sncLibPath)

setSNCMode

void setSNCMode(java.lang.String sncMode)

setSNCQop

void setSNCQop(java.lang.String sncQop)

setSNCTrustedSystems

void setSNCTrustedSystems(java.lang.String sncTrustedSystems)

setSynchronizeUsers

void setSynchronizeUsers(boolean synchronizeUsers)

setUpdateUsers

void setUpdateUsers(boolean updateUsers)

isSSO2DBKeystorePasswordBlank

boolean isSSO2DBKeystorePasswordBlank()

Returns true if the keystore password is blank, or doesn't exist yet.

Returns:

setSSO2DBKeystore

void setSSO2DBKeystore(java.lang.String keystore)

Set the keystore that will be used for SSO

Parameters:

keystore - The base64 encoded SSO keystore

isSSO2DBKeyPasswordBlank

boolean isSSO2DBKeyPasswordBlank()

Returns true if the key password is blank, or doesn't exist yet.

Returns:

getSSO2DBKeystore

java.lang.String getSSO2DBKeystore()

Get the base64 encoded keystore used for SSO

InfoObject properties to query for:

SI_SECSAP_SSO2DB_KEYSTORE

setSSO2DBSystemID

void setSSO2DBSystemID(java.lang.String systemID)

Set the System ID used to identify this BOE system to the rest of the SAP landscape.

getSSO2DBSystemID

java.lang.String getSSO2DBSystemID()

Return the System ID used to identify this BOE system to the rest of the SAP landscape.

InfoObject properties to query for:

SI_SECSAP_SSO2DB_SYSTEM_ID

getSSO2DBKeystorePassword

java.lang.String getSSO2DBKeystorePassword()

Gets the keystore password

setSSO2DBKeystorePassword

void setSSO2DBKeystorePassword(java.lang.String storePassword)

Sets the keystore password

getSSO2DBKeyPassword

java.lang.String getSSO2DBKeyPassword()

Gets the key password

setSSO2DBKeyPassword

void setSSO2DBKeyPassword(java.lang.String keyPassword)

Sets the key password

setSSO2DBKeyAlias

void setSSO2DBKeyAlias(java.lang.String keyAlias)

Sets the key alias

getSSO2DBKeyAlias

java.lang.String getSSO2DBKeyAlias()

gets the key alias