Package com.basis.api.admin

Interface BBjAdminConfiguration

All Superinterfaces:

BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote, Serializable

public interface BBjAdminConfiguration
extends BBjAdminCommitPropertyWriter, Serializable

Contains the configuration for the server in a sigle object that can be used to gather valid properties, display names, valid values, value types. This can be used by clients to build a property sheet that allows setting of all of these valid settings. Client and server do not need to match becasue client will always get the settings for the server it is trying to configure.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_LDAP_ACCESS_BIND_DN
static final String	AUTH_LDAP_ACCESS_BIND_DN2
static final String	AUTH_LDAP_ACCESS_PASSWORD
static final String	AUTH_LDAP_ACCESS_PASSWORD2
static final String	AUTH_LDAP_HOST
static final String	AUTH_LDAP_HOST2
static final String	AUTH_LDAP_PERMISSIONS_LDIF_ADD
static final String	AUTH_LDAP_PERMISSIONS_LDIF_ADD2
static final String	AUTH_LDAP_PERMISSIONS_LDIF_MODIFY
static final String	AUTH_LDAP_PERMISSIONS_LDIF_MODIFY2
static final String	AUTH_LDAP_PERMISSIONS_SEARCH
static final String	AUTH_LDAP_PERMISSIONS_SEARCH2
static final String	AUTH_LDAP_PORT
static final String	AUTH_LDAP_PORT2
static final String	AUTH_LDAP_PREFIX
static final String	AUTH_LDAP_SSL
static final String	AUTH_LDAP_SSL2
static final String	AUTH_LDAP_SUFFIX
static final String	AUTH_LDAP_TIMEOUT
static final String	AUTH_LDAP_USER_MATCH_PATTERNS
static final String	AUTH_LDAP_USER_MATCH_PATTERNS2
static final String	AUTH_LDAP_USER_SEARCH
static final String	AUTH_LDAP_USER_SEARCH2
static final String	AUTH_PASSWORD_EXPIRATION
static final String	AUTH_PASSWORD_MIN_LENGTH
static final String	AUTH_PASSWORD_VALIDATION_TYPE
static final String	AUTH_TYPE
static final String	AUTH_TYPE_BBJ
static final String	AUTH_TYPE_LDAP
static final String	AUTH_TYPE_LDAP2
static final String	AUTH_TYPE_SAML
static final String	AUTH_TYPE_WINDOWS
static final String	BBJ_SERVICES_START_TIME	String value indicating the date and time that BBjServices was last started.
static final int	OS_TYPE_MAC
static final int	OS_TYPE_NIX
static final int	OS_TYPE_WINDOWS
static final int	PASSWORD_VALIDATION_MIXED_CASE
static final int	PASSWORD_VALIDATION_MIXED_CASE_NUMBER
static final int	PASSWORD_VALIDATION_MIXED_CASE_NUMBER_SYMBOL
static final int	PASSWORD_VALIDATION_NONE
static final String	SAML_IDP_CERT_FINGERPRINT
static final String	SAML_IDP_CERT_FINGERPRINT_ALGORITHM
static final String	SAML_IDP_ENTITY_ID
static final String	SAML_IDP_ROLE_ATTRIBUTE
static final String	SAML_IDP_ROLE_DEFAULT
static final String	SAML_IDP_SLS_BINDING
static final String	SAML_IDP_SLS_RESPONSE_URL
static final String	SAML_IDP_SLS_URL
static final String	SAML_IDP_SSO_BINDING
static final String	SAML_IDP_SSO_URL
static final String	SAML_IDP_X509_CERT
static final String	SAML_ORG_DISPLAY_NAME
static final String	SAML_ORG_LANG
static final String	SAML_ORG_NAME
static final String	SAML_ORG_URL
static final String	SAML_SECURITY_AUTHN_REQUEST_SIGNED
static final String	SAML_SECURITY_LOGOUT_REQUEST_SIGNED
static final String	SAML_SECURITY_LOGOUT_RESPONSE_SIGNED
static final String	SAML_SECURITY_NAME_ID_ENCRYPTED
static final String	SAML_SECURITY_REQUESTED_AUTHN_CONTEXT
static final String	SAML_SECURITY_REQUESTED_AUTHN_CONTEXT_COMPARISON
static final String	SAML_SECURITY_SIGNATURE_ALGORITHM
static final String	SAML_SECURITY_WANT_ASSERTIONS_ENCRYPTED
static final String	SAML_SECURITY_WANT_ASSERTIONS_SIGNED
static final String	SAML_SECURITY_WANT_MESSAGES_SIGNED
static final String	SAML_SECURITY_WANT_NAME_ID_ENCRYPTED
static final String	SAML_SP_ACS_BINDING
static final String	SAML_SP_ACS_URL
static final String	SAML_SP_ENTITY_ID
static final String	SAML_SP_PRIVATE_KEY
static final String	SAML_SP_SLS_BINDING
static final String	SAML_SP_SLS_URL
static final String	SAML_SP_X509_CERT
static final String	SAML_SUPPORT_EMAIL
static final String	SAML_SUPPORT_NAME
static final String	SAML_TECHNICAL_EMAIL
static final String	SAML_TECHNICAL_NAME

Method Summary

Modifier and Type	Method	Description
String	generateJWTSharedSecret()	Generates a new shared secret.
BBjAdminList<BBjAdminProperty>	getAdminProperties()	Returns the list of BBjAdminProperty objects that contain the property values as well as information about the type of data, valid values, property name display values, etc.
String	getJWTSharedSecret()	Returns the shared secret used when generating/evaluating JWT authentication tokens.
BBjAdminLDAPSearch	getLDAPPermissionsSearch()	Deprecated.
BBjAdminLDAPSearch	getLDAPUserSearch()	Deprecated.
BBjAdminList<BBjAdminProperty>	getMetricsProperties()	Returns a list of the properties configurable that relate to metrics.
int	getOSType()	Returns the type of the operating system as OS_TYPE_WINDOWS, OS_TYPE_NIX, or OS_TYPE_MAC.
List<BBjAdminProperty>	getSamlProperties()	Returns the list of BBjAdminProperty objects that contain the property values for those properties that are related to SAML single sign-on settings on the server.
BBjAdminList<BBjAdminProperty>	getSecurityProperties()	Returns the list of BBjAdminProperty objects that contain the property values for those properties that are related to the server security settings on the server.
void	setJWTSharedSecret(String p_sharedSecret)	Sets the shared secret used when generating authentication tokens.
void	setSamlProperties(List<BBjAdminProperty> p_properties)	This call updates the SAML settings in the saml.properties file immediately upon making this call.

Methods inherited from interface com.basis.api.admin.BBjAdminCommitPropertyWriter

getChangedProperties, getClearedProperties, getOriginalProperties

Methods inherited from interface com.basis.api.admin.BBjAdminCommitWriter

commit, rollback

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

checkValueEqual, contains, contains, getBoolean, getDouble, getInt, getList, getLong, getProperties, getString, getType, getTypes, getValue

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter

addType, canAddNewProperties, canClear, clear, clearProperties, clearProperty, getReadOnly, hasChanged, isReadOnly, setBoolean, setDouble, setInt, setList, setLong, setProperties, setString, setValue

Field Details

AUTH_TYPE

static final String AUTH_TYPE

See Also:

• Constant Field Values

AUTH_TYPE_BBJ

static final String AUTH_TYPE_BBJ

See Also:

• Constant Field Values

AUTH_TYPE_LDAP

static final String AUTH_TYPE_LDAP

See Also:

• Constant Field Values

AUTH_TYPE_WINDOWS

static final String AUTH_TYPE_WINDOWS

See Also:

• Constant Field Values

AUTH_TYPE_LDAP2

static final String AUTH_TYPE_LDAP2

See Also:

• Constant Field Values

AUTH_TYPE_SAML

static final String AUTH_TYPE_SAML

See Also:

• Constant Field Values

AUTH_PASSWORD_EXPIRATION

static final String AUTH_PASSWORD_EXPIRATION

See Also:

• Constant Field Values

AUTH_PASSWORD_MIN_LENGTH

static final String AUTH_PASSWORD_MIN_LENGTH

See Also:

• Constant Field Values

AUTH_PASSWORD_VALIDATION_TYPE

static final String AUTH_PASSWORD_VALIDATION_TYPE

See Also:

• Constant Field Values

AUTH_LDAP_HOST

static final String AUTH_LDAP_HOST

See Also:

• Constant Field Values

AUTH_LDAP_PORT

static final String AUTH_LDAP_PORT

See Also:

• Constant Field Values

AUTH_LDAP_TIMEOUT

static final String AUTH_LDAP_TIMEOUT

See Also:

• Constant Field Values

AUTH_LDAP_PREFIX

static final String AUTH_LDAP_PREFIX

See Also:

• Constant Field Values

AUTH_LDAP_SUFFIX

static final String AUTH_LDAP_SUFFIX

See Also:

• Constant Field Values

AUTH_LDAP_SSL

static final String AUTH_LDAP_SSL

See Also:

• Constant Field Values

AUTH_LDAP_USER_SEARCH

static final String AUTH_LDAP_USER_SEARCH

See Also:

• Constant Field Values

AUTH_LDAP_PERMISSIONS_SEARCH

static final String AUTH_LDAP_PERMISSIONS_SEARCH

See Also:

• Constant Field Values

AUTH_LDAP_ACCESS_BIND_DN

static final String AUTH_LDAP_ACCESS_BIND_DN

See Also:

• Constant Field Values

AUTH_LDAP_ACCESS_PASSWORD

static final String AUTH_LDAP_ACCESS_PASSWORD

See Also:

• Constant Field Values

AUTH_LDAP_PERMISSIONS_LDIF_ADD

static final String AUTH_LDAP_PERMISSIONS_LDIF_ADD

See Also:

• Constant Field Values

AUTH_LDAP_PERMISSIONS_LDIF_MODIFY

static final String AUTH_LDAP_PERMISSIONS_LDIF_MODIFY

See Also:

• Constant Field Values

AUTH_LDAP_USER_MATCH_PATTERNS

static final String AUTH_LDAP_USER_MATCH_PATTERNS

See Also:

• Constant Field Values

AUTH_LDAP_HOST2

static final String AUTH_LDAP_HOST2

See Also:

• Constant Field Values

AUTH_LDAP_PORT2

static final String AUTH_LDAP_PORT2

See Also:

• Constant Field Values

AUTH_LDAP_SSL2

static final String AUTH_LDAP_SSL2

See Also:

• Constant Field Values

AUTH_LDAP_USER_SEARCH2

static final String AUTH_LDAP_USER_SEARCH2

See Also:

• Constant Field Values

AUTH_LDAP_PERMISSIONS_SEARCH2

static final String AUTH_LDAP_PERMISSIONS_SEARCH2

See Also:

• Constant Field Values

AUTH_LDAP_ACCESS_BIND_DN2

static final String AUTH_LDAP_ACCESS_BIND_DN2

See Also:

• Constant Field Values

AUTH_LDAP_ACCESS_PASSWORD2

static final String AUTH_LDAP_ACCESS_PASSWORD2

See Also:

• Constant Field Values

AUTH_LDAP_PERMISSIONS_LDIF_ADD2

static final String AUTH_LDAP_PERMISSIONS_LDIF_ADD2

See Also:

• Constant Field Values

AUTH_LDAP_PERMISSIONS_LDIF_MODIFY2

static final String AUTH_LDAP_PERMISSIONS_LDIF_MODIFY2

See Also:

• Constant Field Values

AUTH_LDAP_USER_MATCH_PATTERNS2

static final String AUTH_LDAP_USER_MATCH_PATTERNS2

See Also:

• Constant Field Values

PASSWORD_VALIDATION_NONE

static final int PASSWORD_VALIDATION_NONE

See Also:

• Constant Field Values

PASSWORD_VALIDATION_MIXED_CASE

static final int PASSWORD_VALIDATION_MIXED_CASE

See Also:

• Constant Field Values

PASSWORD_VALIDATION_MIXED_CASE_NUMBER

static final int PASSWORD_VALIDATION_MIXED_CASE_NUMBER

See Also:

• Constant Field Values

PASSWORD_VALIDATION_MIXED_CASE_NUMBER_SYMBOL

static final int PASSWORD_VALIDATION_MIXED_CASE_NUMBER_SYMBOL

See Also:

• Constant Field Values

OS_TYPE_NIX

static final int OS_TYPE_NIX

See Also:

• Constant Field Values

OS_TYPE_WINDOWS

static final int OS_TYPE_WINDOWS

See Also:

• Constant Field Values

OS_TYPE_MAC

static final int OS_TYPE_MAC

See Also:

• Constant Field Values

SAML_SP_ENTITY_ID

static final String SAML_SP_ENTITY_ID

See Also:

• Constant Field Values

SAML_SP_ACS_URL

static final String SAML_SP_ACS_URL

See Also:

• Constant Field Values

SAML_SP_ACS_BINDING

static final String SAML_SP_ACS_BINDING

See Also:

• Constant Field Values

SAML_SP_SLS_URL

static final String SAML_SP_SLS_URL

See Also:

• Constant Field Values

SAML_SP_SLS_BINDING

static final String SAML_SP_SLS_BINDING

See Also:

• Constant Field Values

SAML_SP_X509_CERT

static final String SAML_SP_X509_CERT

See Also:

• Constant Field Values

SAML_SP_PRIVATE_KEY

static final String SAML_SP_PRIVATE_KEY

See Also:

• Constant Field Values

SAML_IDP_ENTITY_ID

static final String SAML_IDP_ENTITY_ID

See Also:

• Constant Field Values

SAML_IDP_SSO_URL

static final String SAML_IDP_SSO_URL

See Also:

• Constant Field Values

SAML_IDP_SSO_BINDING

static final String SAML_IDP_SSO_BINDING

See Also:

• Constant Field Values

SAML_IDP_SLS_URL

static final String SAML_IDP_SLS_URL

See Also:

• Constant Field Values

SAML_IDP_SLS_RESPONSE_URL

static final String SAML_IDP_SLS_RESPONSE_URL

See Also:

• Constant Field Values

SAML_IDP_SLS_BINDING

static final String SAML_IDP_SLS_BINDING

See Also:

• Constant Field Values

SAML_IDP_X509_CERT

static final String SAML_IDP_X509_CERT

See Also:

• Constant Field Values

SAML_IDP_CERT_FINGERPRINT

static final String SAML_IDP_CERT_FINGERPRINT

See Also:

• Constant Field Values

SAML_IDP_CERT_FINGERPRINT_ALGORITHM

static final String SAML_IDP_CERT_FINGERPRINT_ALGORITHM

See Also:

• Constant Field Values

SAML_IDP_ROLE_ATTRIBUTE

static final String SAML_IDP_ROLE_ATTRIBUTE

See Also:

• Constant Field Values

SAML_IDP_ROLE_DEFAULT

static final String SAML_IDP_ROLE_DEFAULT

See Also:

• Constant Field Values

SAML_SECURITY_NAME_ID_ENCRYPTED

static final String SAML_SECURITY_NAME_ID_ENCRYPTED

See Also:

• Constant Field Values

SAML_SECURITY_AUTHN_REQUEST_SIGNED

static final String SAML_SECURITY_AUTHN_REQUEST_SIGNED

See Also:

• Constant Field Values

SAML_SECURITY_LOGOUT_REQUEST_SIGNED

static final String SAML_SECURITY_LOGOUT_REQUEST_SIGNED

See Also:

• Constant Field Values

SAML_SECURITY_LOGOUT_RESPONSE_SIGNED

static final String SAML_SECURITY_LOGOUT_RESPONSE_SIGNED

See Also:

• Constant Field Values

SAML_SECURITY_WANT_MESSAGES_SIGNED

static final String SAML_SECURITY_WANT_MESSAGES_SIGNED

See Also:

• Constant Field Values

SAML_SECURITY_WANT_ASSERTIONS_SIGNED

static final String SAML_SECURITY_WANT_ASSERTIONS_SIGNED

See Also:

• Constant Field Values

SAML_SECURITY_WANT_ASSERTIONS_ENCRYPTED

static final String SAML_SECURITY_WANT_ASSERTIONS_ENCRYPTED

See Also:

• Constant Field Values

SAML_SECURITY_WANT_NAME_ID_ENCRYPTED

static final String SAML_SECURITY_WANT_NAME_ID_ENCRYPTED

See Also:

• Constant Field Values

SAML_SECURITY_REQUESTED_AUTHN_CONTEXT

static final String SAML_SECURITY_REQUESTED_AUTHN_CONTEXT

See Also:

• Constant Field Values

SAML_SECURITY_REQUESTED_AUTHN_CONTEXT_COMPARISON

static final String SAML_SECURITY_REQUESTED_AUTHN_CONTEXT_COMPARISON

See Also:

• Constant Field Values

SAML_SECURITY_SIGNATURE_ALGORITHM

static final String SAML_SECURITY_SIGNATURE_ALGORITHM

See Also:

• Constant Field Values

SAML_ORG_NAME

static final String SAML_ORG_NAME

See Also:

• Constant Field Values

SAML_ORG_DISPLAY_NAME

static final String SAML_ORG_DISPLAY_NAME

See Also:

• Constant Field Values

SAML_ORG_URL

static final String SAML_ORG_URL

See Also:

• Constant Field Values

SAML_ORG_LANG

static final String SAML_ORG_LANG

See Also:

• Constant Field Values

SAML_TECHNICAL_NAME

static final String SAML_TECHNICAL_NAME

See Also:

• Constant Field Values

SAML_TECHNICAL_EMAIL

static final String SAML_TECHNICAL_EMAIL

See Also:

• Constant Field Values

SAML_SUPPORT_NAME

static final String SAML_SUPPORT_NAME

See Also:

• Constant Field Values

SAML_SUPPORT_EMAIL

static final String SAML_SUPPORT_EMAIL

See Also:

• Constant Field Values

BBJ_SERVICES_START_TIME

static final String BBJ_SERVICES_START_TIME

String value indicating the date and time that BBjServices was last started.

See Also:

• Constant Field Values

Method Details

getAdminProperties

BBjAdminList<BBjAdminProperty> getAdminProperties()
                                           throws BBjAdminException

Returns the list of BBjAdminProperty objects that contain the property values as well as information about the type of data, valid values, property name display values, etc.

Throws:

BBjAdminException

getMetricsProperties

BBjAdminList<BBjAdminProperty> getMetricsProperties()
                                             throws BBjAdminException

Returns a list of the properties configurable that relate to metrics. This includes the individual metrics that can be enabled/disabled as well as the URL used to access the metrics, typically by a Prometheus server.

Throws:

BBjAdminException

getSecurityProperties

BBjAdminList<BBjAdminProperty> getSecurityProperties()
                                              throws BBjAdminException

Returns the list of BBjAdminProperty objects that contain the property values for those properties that are related to the server security settings on the server. There may be values in here for LDAP, even if LDAP is not configured, or BBj, even if another method is set. Use the AUTH_TYPE property from this list to determine the current type being used. The reason the other settings are available is so that you can set the various settings for another authentication type before you are actually read to enable that alternate type.

Throws:

BBjAdminException

getSamlProperties

List<BBjAdminProperty> getSamlProperties()
                                  throws BBjAdminException

Returns the list of BBjAdminProperty objects that contain the property values for those properties that are related to SAML single sign-on settings on the server.

Throws:

BBjAdminException

setSamlProperties

void setSamlProperties(List<BBjAdminProperty> p_properties)
                throws BBjAdminException

This call updates the SAML settings in the saml.properties file immediately upon making this call.

Parameters:

p_properties -

Throws:

BBjAdminException

getLDAPUserSearch

@Deprecated
BBjAdminLDAPSearch getLDAPUserSearch()
                              throws BBjAdminException

Deprecated.

Returns the LDAP search for locating users.

Throws:

BBjAdminException

getLDAPPermissionsSearch

@Deprecated
BBjAdminLDAPSearch getLDAPPermissionsSearch()
                                     throws BBjAdminException

Deprecated.

Returns the LDAP search for locating user permissions.

Throws:

BBjAdminException

getOSType

int getOSType()

Returns the type of the operating system as OS_TYPE_WINDOWS, OS_TYPE_NIX, or OS_TYPE_MAC.

getJWTSharedSecret

String getJWTSharedSecret()
                   throws BBjAdminException

Returns the shared secret used when generating/evaluating JWT authentication tokens.

Returns:

The shared secret used when generating/evaluating JWT authentication tokens.

Throws:

BBjAdminException

setJWTSharedSecret

void setJWTSharedSecret(String p_sharedSecret)
                 throws BBjAdminException

Sets the shared secret used when generating authentication tokens. Make sure to call the commit() method to save the changes. This value is typically a base-64 encoded string.

Parameters:

p_sharedSecret - The shared secret used when generating/evaluating JWT authentication tokens.

Throws:

BBjAdminException

generateJWTSharedSecret

String generateJWTSharedSecret()
                        throws BBjAdminException

Generates a new shared secret. This value can then be passed into the setJWTSharedSecret() method to set the shared secret for generating/evaluating JWT authentication tokens on this server. This does not change the shared secret on the server. You must call setJWTSharedSecret() followed by commit().

Returns:

The new shared secret.

Throws:

BBjAdminException