Skip navigation links

Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services
11g Release 1 (11.1.1)

E14651-04


oracle.security.jps.mas.mgmt.jmx.config
Interface JpsConfigMXBean


@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@ImmutableInfo(value="true")
@Since(value="11.1.1.0.0")
@Visibility(value=Advanced)
@SystemMBean
public interface JpsConfigMXBean

Interface that exposes jmx methods to manage Jps configuration i.e., jps-config.xml


Field Summary
static java.lang.String ACTIVE_DIRECTORY
           
static java.lang.String AES_128_CBC
           
static java.lang.String AES_192_CBC
           
static java.lang.String AES_256_CBC
           
static java.lang.String ANONYMOUS
          Deprecated.  
static java.lang.String AUDIT
           
static java.lang.String COREID
           
static java.lang.String CREDENTIAL_STORE
           
static java.lang.String DES_EDE_CBC
           
static java.lang.String EDIRECTORY
           
static java.lang.String IDENTITY_STORE
           
static java.lang.String IDM
          Deprecated.  
static java.lang.String IGF_STORE
           
static java.lang.String IPLANET
           
static java.lang.String KEYSTORE
           
static java.lang.String OID
           
static java.lang.String OPEN_LDAP
           
static java.lang.String POLICY_STORE
           
static java.lang.String RBN
           
static java.lang.String SSO
           

 

Method Summary
 void addExtendedPropertySetRefToServiceInstance(java.lang.String serviceInstName, java.lang.String extPropSetRef)
          Function to add an extended property set reference to a specific Service Instance
 void addKeyStoreService(java.lang.String ctxName, java.lang.String path, java.lang.String type, char[] password, java.lang.String signatureAlias, char[] signaturePassword, java.lang.String cryptAlias, char[] cryptPassword, PortableMap pm)
          Method to add a Key Store Service to the Context
 void addLoginModule(java.lang.String ctxName, java.lang.String name)
          Function to add a Login Module to the Context whose service instance already exists.
 void addNewLoginModule(java.lang.String ctxName, java.lang.String name, java.lang.String loginModuleClzName, java.lang.String controlFlag, boolean debug, boolean addRoles, PortableMap pm)
          Function which will add a New Login Module to the Configuration.
 void addPropertySetRefToServiceInstance(java.lang.String serviceInstName, java.lang.String propSetRef)
          Function to add a property set reference to a specific Service Instance
 void addSAMLLoginModule(java.lang.String ctxName, java.lang.String name, java.lang.String controlFlag, boolean debug, boolean addRoles, PortableMap pm, java.lang.String[] arrIssuers)
          Function to add a SAML Login Module to a Context.
 void addServiceInstanceRefsToServiceInstance(java.lang.String serviceInstName, java.lang.String[] servInstanceRefNames)
          Function to add child service instances to a specific Service Instance
 void checkAndSeedSchema()
          Function to check if the schema is seeded in the target security store.
 boolean checkServiceSetUp(PortableMap mp, java.lang.String serviceType)
          Deprecated. As of release 11gR1, replaced by JpsConfigMXBean.checkServiceSetUp(String, char[], PortableMap, String) Function to check pre-requisites that are required for setting up the service.
 void checkServiceSetUp(java.lang.String userName, char[] password, PortableMap mp, java.lang.String serviceType)
          Function to check pre-requisites that are required for setting up the service.
 void configureLdapCSFStore(java.lang.String ctxName, java.lang.String ldapURL, java.lang.String adminDN, char[] password, java.lang.String subscriberName, PortableMap mp)
          Function to configure a LDAP Based CSF Store
 void configureLDAPIdentityStoreWithLibOvd(java.lang.String ctxName, java.lang.String adminDN, char[] password, java.lang.String[] arrUsrSearchBase, java.lang.String[] arrGrpSearchBase, PortableMap mp, java.lang.String[] serviceInstNames)
          Function to configure a LDAP Based Identity Store with reference to other services representing LDAPs (This is to support the use liBOvd as backend store) This is targeted for Off-Weblogic platform usage
 void configureLdapPolicyStore(java.lang.String ctxName, java.lang.String ldapURL, java.lang.String adminDN, char[] password, PortableMap mp)
          Function to configure a LDAP Based Identity Store
 void configureLDAPServerAsIdentityStoreService(java.lang.String ldapURL, java.lang.String adminDN, char[] password, java.lang.String type, java.lang.String subscriberName, java.lang.String[] arrUsrSearchBase, java.lang.String[] arrGrpSearchBase, PortableMap mp)
          Function to configure an LDAP server as Identity Store Service instance in the config (note: the created instance is in the global level, not added to any JPS Context).
 void configureLDAPServerAsIdentityStoreService(java.lang.String ldapURL, java.lang.String alias, java.lang.String key, java.lang.String type, java.lang.String subscriberName, java.lang.String[] arrUsrSearchBase, java.lang.String[] arrGrpSearchBase, PortableMap mp)
          Function to configure an LDAP server as Identity Store Service instance in the config.
 void configureSSO(java.lang.String ctx, PortableMap authURIProps, PortableMap authLevelProps, PortableMap serviceProps)
          Function to configure SSO service in the specified context
 void deleteLoginModule(java.lang.String lmName)
          Function to delete specific Login Module Service Instance from jps-config.xml file All the references to this service instance in all the contexts is also deleted.
 java.lang.String exportAuditConfig(java.lang.String filterPreset, java.lang.String specialUsers, java.lang.String customEvents)
          Deprecated. Returns the audit configuration
 PortableExtendedProperty[] getAllExtendedPropertySets()
          Returns all the extended property sets
 java.lang.String[] getAllLoginModuleNames()
          Function to return all the Login Module names that exist in the configuration
 PortableMap getAllProperties()
          Function to return all the Properties at the global level that are associated within this Configuration MBean
 PortablePropertySet[] getAllPropertySets()
          Returns all the property sets defined at the global level
 PortableAuditConfig getAuditConfiguration()
          Returns the audit configuration structure
 PortableAuditLoaderConfig getAuditLoaderConfiguration()
          Returns the audit loader configuration structure
 PortableComponentEvents[] getComponentEvents(java.lang.String language)
          Deprecated. Gets the component events of all components for audit service
 PortableContext getContext(java.lang.String name)
          Function to get a specific Context.
 java.lang.String getCustomEvents()
          Deprecated. Returns the custom events for audit service
 PortableContext getDefaultContext()
          Function to get the Default Context
 PortableExtendedProperty getExtendedPropertySet(java.lang.String name)
          Returns the extended property associated with the specified name
 java.lang.String getFilterPreset()
          Deprecated. Returns the filter preset for audit service
 PortableLoginModule getLoginModule(java.lang.String name)
          Function to return information about a specific Login Module
 java.lang.String[] getLoginModuleNames(java.lang.String ctxName)
          Function which will return all the Login Module Names within a Context
 long getMaxLogDirSize()
          Deprecated. Returns the max log directory size for audit logs
 long getMaxLogFileSize()
          Deprecated. Returns the max log file size for audit log file
 java.lang.String getProperty(java.lang.String name)
          Returns the global property associated with the specified name.
 PortablePropertySet getPropertySet(java.lang.String name)
          Returns the global property set associated with the specified name
 PortableServiceInstance getServiceConfig(java.lang.String ctx, java.lang.String serviceType)
          Function to return information about a specific Service Type for a Context
 java.lang.String getSpecialUsers()
          Deprecated. Returns the special users for audit service
 PortableAuditConfig importAuditConfig(java.lang.String auditConfig)
          Deprecated. Returns the audit configuration structure
 void migrateData()
          Function to migrate data from the existing security store to the target store.
 void persist()
          Persists this JpsConfiguration object.
 void refresh()
          Refreshes state by reloading from backing store (which might have changed)
 void removeAllExtendedPropertySets()
          Function to remove all PortableExtendedProperty
 void removeAllProperties()
          Function to remove all the Properties defined at the global level associated with the Configuration MBean
 void removeAllPropertySets()
          Function to remove all PortablePropertySets defined at the global level
 PortableExtendedProperty removeExtendedPropertySet(java.lang.String name)
          Function to remove a PortableExtendedProperty
 void removeExtendedPropertySetRefToServiceInstance(java.lang.String serviceInstName, java.lang.String extPropSetRef)
          Function to remove an extended property set reference from a Service Instance
 void removeLoginModule(java.lang.String ctxName, java.lang.String name)
          Function to remove the reference to a specific Login Module from a Context
 java.lang.String removeProperty(java.lang.String name)
          Function to remove a global Property
 PortablePropertySet removePropertySet(java.lang.String name)
          Function to remove a global PortablePropertySet
 void removePropertySetRefToServiceInstance(java.lang.String serviceInstName, java.lang.String propSetRef)
          Function to remove a property set reference from a Service Instance
 PortableExtendedPropertyType removeServiceInstanceExtendedProperty(java.lang.String siName, java.lang.String name)
          Function to remove a extended property within a Service Instance
 java.lang.String removeServiceInstanceProperty(java.lang.String siName, java.lang.String name)
          Function to remove a property within a Service Instance
 void removeServiceInstanceRefsFromServiceInstance(java.lang.String serviceInstName, java.lang.String[] servInstanceRefNames)
          Function to remove child service instances from a specific Service Instance
 void removeServiceType(java.lang.String ctxName, java.lang.String type)
          Method to remove a configured Service from the Context.
 void setAuditConfiguration(PortableAuditConfig auditConfig)
          Sets the audit configuration structure
 void setAuditLoaderConfiguration(PortableAuditLoaderConfig auditLoaderConfig)
          Sets the audit loader configuration structure
 void setCustomEvents(java.lang.String customEvents)
          Deprecated. Sets the custom events for audit service
 void setFilterPreset(java.lang.String filterPreset)
          Deprecated. Sets the filter preset for audit service
 void setMaxLogDirSize(long maxLogDirSize)
          Deprecated. Sets the max log directory size for audit logs
 void setMaxLogFileSize(long maxLogFileSize)
          Deprecated. Sets the max log file size for audit log
 void setSpecialUsers(java.lang.String specialUsers)
          Deprecated. Sets the special users for audit service
 void testJpsRootDN(java.lang.String host, int port, java.lang.String userDN, char[] password, java.lang.String JpsRootDN)
          Deprecated. Function which will test for connection to a specific LDAP Server and validate JpsRootDN
 void testJpsRootDN(java.lang.String url, java.lang.String userDN, char[] password, java.lang.String jpsRootDN)
          Function which will test for connection to a specific LDAP Server and validate JpsRootDN
 void testJpsService()
          Function to validate the service after data migration.
 void testLDAPConnection(java.lang.String host, int port, java.lang.String userDN, char[] password)
          Deprecated. Function which will test for connection to a specific LDAP Server
 void testLDAPConnection(java.lang.String url, java.lang.String userDN, char[] password)
          Function which will test for connection to a specific LDAP Server
 PortableExtendedProperty updateExtendedPropertySet(java.lang.String name, PortableExtendedProperty ps)
          Function to update a PortableExtendedProperty.
 void updateFileBasedCredentialStore(java.lang.String fileName, java.lang.String ctxName)
          Function to add a wallet file based Credential Store to the Context.
 void updateFileBasedIdentityStore(java.lang.String fileName, java.lang.String realmName, java.lang.String ctxName)
          Function to add a file based identity store to the Context.
 void updateFileBasedPolicyStore(java.lang.String fileName, java.lang.String ctxName)
          Function to add a file based policy store to the Context.
 void updateKerberosLoginModule(java.lang.String name, java.lang.String controlFlag, boolean debug, boolean addRoles, java.lang.String principal, java.lang.String keyTabFile, PortableMap pm)
          Function to configure a Kerberos Login Module.
 void updateLDAPReassociationConfiguration()
          Function to update jps-config.xml after successful re-association to the target security store.
 void updateLoginModule(java.lang.String ctxName, java.lang.String name, java.lang.String loginModuleClzName, java.lang.String controlFlag, boolean debug, boolean addRoles, PortableMap pm)
          Function which will update an existing Login Module.
 java.lang.String updateProperty(java.lang.String name, java.lang.String value)
          Function to update a Property at the global level.
 PortablePropertySet updatePropertySet(java.lang.String name, PortablePropertySet ps)
          Function to update a global PortablePropertySet.
 void updateSAMLLoginModule(java.lang.String ctxName, java.lang.String name, java.lang.String controlFlag, boolean debug, boolean addRoles, PortableMap pm, java.lang.String[] arrIssuers)
          Function to update a SAML Login Module to a Context
 PortableExtendedPropertyType updateServiceInstanceExtendedProperty(java.lang.String siName, PortableExtendedPropertyType value)
          Function which will update (over writes) a extended property within a Service Instance.
 java.lang.String updateServiceInstanceProperty(java.lang.String siName, java.lang.String name, java.lang.String value)
          Function which will update a property within a Service Instance.
 void updateTrustServiceConfig(java.lang.String ctxName, java.lang.String providerName, PortableMap pMap)
          Updates Trust Service provider configuration
 java.lang.String[] validateAuditDataSources(java.lang.String[] jndi)
          Deprecated. Validates the audit data sources
 void validateExpression(java.lang.String componentType, java.lang.String eventName, java.lang.String expression)
          Deprecated. Validates the filter expression

 

Field Detail

RBN

static final java.lang.String RBN
See Also:
Constant Field Values

AES_128_CBC

static final java.lang.String AES_128_CBC
See Also:
Constant Field Values

AES_192_CBC

static final java.lang.String AES_192_CBC
See Also:
Constant Field Values

AES_256_CBC

static final java.lang.String AES_256_CBC
See Also:
Constant Field Values

DES_EDE_CBC

static final java.lang.String DES_EDE_CBC
See Also:
Constant Field Values

OID

static final java.lang.String OID

ACTIVE_DIRECTORY

static final java.lang.String ACTIVE_DIRECTORY

IPLANET

static final java.lang.String IPLANET

EDIRECTORY

static final java.lang.String EDIRECTORY

OPEN_LDAP

static final java.lang.String OPEN_LDAP

COREID

static final java.lang.String COREID

IDENTITY_STORE

static final java.lang.String IDENTITY_STORE

CREDENTIAL_STORE

static final java.lang.String CREDENTIAL_STORE

POLICY_STORE

static final java.lang.String POLICY_STORE

IGF_STORE

static final java.lang.String IGF_STORE

IDM

static final java.lang.String IDM
Deprecated. 

ANONYMOUS

static final java.lang.String ANONYMOUS
Deprecated. 

KEYSTORE

static final java.lang.String KEYSTORE

AUDIT

static final java.lang.String AUDIT

SSO

static final java.lang.String SSO

Method Detail

persist

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void persist()
             throws oracle.as.jmx.framework.exceptions.ManagementException
Persists this JpsConfiguration object.
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

refresh

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void refresh()
             throws oracle.as.jmx.framework.exceptions.ManagementException
Refreshes state by reloading from backing store (which might have changed)
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updateFileBasedIdentityStore

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void updateFileBasedIdentityStore(java.lang.String fileName,
                                                     java.lang.String realmName,
                                                     java.lang.String ctxName)
                                  throws oracle.as.jmx.framework.exceptions.ManagementException
Function to add a file based identity store to the Context. If the Context name is null, the default Context will be used
Parameters:
fileName - Name of the file which has to be referenced by the service
realmName - Name of the default realm for this identity store
ctxName - Name of the Context where the service is to be added
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updateFileBasedPolicyStore

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void updateFileBasedPolicyStore(java.lang.String fileName,
                                                   java.lang.String ctxName)
                                throws oracle.as.jmx.framework.exceptions.ManagementException
Function to add a file based policy store to the Context. If the Context name is null, the default Context will be used
Parameters:
fileName - Name of the file which has to be referenced by the service
ctxName - Name of the Context where the service is to be added
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updateFileBasedCredentialStore

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void updateFileBasedCredentialStore(java.lang.String fileName,
                                                       java.lang.String ctxName)
                                    throws oracle.as.jmx.framework.exceptions.ManagementException
Function to add a wallet file based Credential Store to the Context. If the Context name is null, the default Context will be used
Parameters:
fileName - Name of the file which has to be referenced by the service
ctxName - Name of the Context where the service is to be added
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

testLDAPConnection

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
@Deprecated
void testLDAPConnection(java.lang.String host,
                                                      int port,
                                                      java.lang.String userDN,
                                                      char[] password)
                        throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Function which will test for connection to a specific LDAP Server
Parameters:
host - LDAP Server host
port - Port to connect to
userDN - Distinguished Name of the User (cn=admin)
password - Password
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

testLDAPConnection

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
void testLDAPConnection(java.lang.String url,
                                           java.lang.String userDN,
                                           char[] password)
                        throws oracle.as.jmx.framework.exceptions.ManagementException
Function which will test for connection to a specific LDAP Server
Parameters:
url - The url which is of the form ldap://host:port for non-secure and ldaps://host:port for secure
userDN - Distinguished Name of the User (cn=admin)
password - Password
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

testJpsRootDN

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
@Deprecated
void testJpsRootDN(java.lang.String host,
                                                 int port,
                                                 java.lang.String userDN,
                                                 char[] password,
                                                 java.lang.String JpsRootDN)
                   throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Function which will test for connection to a specific LDAP Server and validate JpsRootDN
Parameters:
host - LDAP Server host
port - Port to connect to
userDN - Distinguished Name of the User (cn=admin)
password - Password
JpsRootDN - JpsRootDN that needs to validated
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

testJpsRootDN

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
void testJpsRootDN(java.lang.String url,
                                      java.lang.String userDN,
                                      char[] password,
                                      java.lang.String jpsRootDN)
                   throws oracle.as.jmx.framework.exceptions.ManagementException
Function which will test for connection to a specific LDAP Server and validate JpsRootDN
Parameters:
url - The url which is of the form ldap://host:port for non-secure and ldaps://host:port for secure
userDN - Distinguished Name of the User (cn=admin)
password - Password
jpsRootDN - JpsRootDN that needs to validated
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

configureLDAPIdentityStoreWithLibOvd

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void configureLDAPIdentityStoreWithLibOvd(java.lang.String ctxName,
                                                             java.lang.String adminDN,
                                                             char[] password,
                                                             java.lang.String[] arrUsrSearchBase,
                                                             java.lang.String[] arrGrpSearchBase,
                                                             PortableMap mp,
                                                             java.lang.String[] serviceInstNames)
                                          throws oracle.as.jmx.framework.exceptions.ManagementException
Function to configure a LDAP Based Identity Store with reference to other services representing LDAPs (This is to support the use liBOvd as backend store) This is targeted for Off-Weblogic platform usage
Parameters:
ctxName - The Name of the Context where the configuration should be done. If null, then the configuration is made to the default Context
adminDN - The Distinguished name of the Admin (required)
password - Password for the Admin (required)
arrUsrSearchBase - Array which contains the global/front Search base for the User, null if not to specifiy)
arrGrpSearchBase - Array which contains the global/front Search base for the Group, null if not to specifiy
mp - Map containing the other additional properties that needs to be configured. Eg. SSL etc pass null if no additional properties are required
serviceInstNames - names of other child service instances representing LDAP servers behind the libOvd
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

configureLDAPServerAsIdentityStoreService

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void configureLDAPServerAsIdentityStoreService(java.lang.String ldapURL,
                                                                  java.lang.String adminDN,
                                                                  char[] password,
                                                                  java.lang.String type,
                                                                  java.lang.String subscriberName,
                                                                  java.lang.String[] arrUsrSearchBase,
                                                                  java.lang.String[] arrGrpSearchBase,
                                                                  PortableMap mp)
                                               throws oracle.as.jmx.framework.exceptions.ManagementException
Function to configure an LDAP server as Identity Store Service instance in the config (note: the created instance is in the global level, not added to any JPS Context). This is targeted for Off-Weblogic platform usage
Parameters:
ldapURL - URL which should be used to connect to the LDAP Server. Format is host:port
adminDN - The Distinguished name of the Admin
password - Password for the Admin
type - Type of the LDAP Server (Eg. OID)
subscriberName - Subscriber Name
arrUsrSearchBase - Array which contains the Search base for the User
arrGrpSearchBase - Array which contains the Search base for the Group
mp - Map containing the other additional properties that needs to be configured. Eg. SSL etc pass null if no additional properties are required
serviceInstNames - names of other service instances which to be referenced
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

configureLDAPServerAsIdentityStoreService

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void configureLDAPServerAsIdentityStoreService(java.lang.String ldapURL,
                                                                  java.lang.String alias,
                                                                  java.lang.String key,
                                                                  java.lang.String type,
                                                                  java.lang.String subscriberName,
                                                                  java.lang.String[] arrUsrSearchBase,
                                                                  java.lang.String[] arrGrpSearchBase,
                                                                  PortableMap mp)
                                               throws oracle.as.jmx.framework.exceptions.ManagementException
Function to configure an LDAP server as Identity Store Service instance in the config. (note: the created instance is in the global level, not added to any JPS Context). This is targeted for Off-Weblogic platform usage
Parameters:
ldapURL - URL which should be used to connect to the LDAP Server. Format is host:port
alias - Alias of the Credential
key - Key for the Credential
type - Type of the LDAP Server (Eg. OID)
subscriberName - Subscriber Name
arrUsrSearchBase - Array which contains the Search base for the User
arrGrpSearchBase - Array which contains the Search base for the Group
mp - Map containing the other additional properties that needs to be configured. Eg. SSL etc pass null if no additional properties are required
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

configureLdapCSFStore

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void configureLdapCSFStore(java.lang.String ctxName,
                                              java.lang.String ldapURL,
                                              java.lang.String adminDN,
                                              char[] password,
                                              java.lang.String subscriberName,
                                              PortableMap mp)
                           throws oracle.as.jmx.framework.exceptions.ManagementException
Function to configure a LDAP Based CSF Store
Parameters:
ctxName - The Name of the Context where the configuration should be done. If null, then the configuration is made to the default Context
ldapURL - URL which should be used to connect to the LDAP Server. Format is host:port
adminDN - The Distinguished name of the Admin
password - Password for the Admin
subscriberName - Subscriber Name
mp - Map containing the other additional properties that needs to be configured. Eg. SSL etc pass null if no additional properties are required
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

configureLdapPolicyStore

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void configureLdapPolicyStore(java.lang.String ctxName,
                                                 java.lang.String ldapURL,
                                                 java.lang.String adminDN,
                                                 char[] password,
                                                 PortableMap mp)
                              throws oracle.as.jmx.framework.exceptions.ManagementException
Function to configure a LDAP Based Identity Store
Parameters:
ctxName - The Name of the Context where the configuration should be done. If null, then the configuration is made to the default Context
ldapURL - URL which should be used to connect to the LDAP Server. Format is host:port
adminDN - The Distinguished name of the Admin
password - Password for the Admin
mp - Map containing the other additional properties that needs to be configured. Eg. SSL etc pass null if no additional properties are required
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

addNewLoginModule

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void addNewLoginModule(java.lang.String ctxName,
                                          java.lang.String name,
                                          java.lang.String loginModuleClzName,
                                          java.lang.String controlFlag,
                                          boolean debug,
                                          boolean addRoles,
                                          PortableMap pm)
                       throws oracle.as.jmx.framework.exceptions.ManagementException
Function which will add a New Login Module to the Configuration. This will create the Service Instance with the information passed. It will then create a reference to the created Service Instance
Parameters:
ctxName - Name of Context where the reference has to be created. If null, the default Context is used
name - Name of the Login Module
loginModuleClzName - Class Name for the Login Module
controlFlag - Control Flag for the Login Module. Values are - required, requisite, sufficient, optional
debug - Flag to set the debug option
addRoles - Flag to set the add Roles option
pm - Map containing the other additional properties that needs to be configured. pass null if no additional properties are required
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updateLoginModule

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void updateLoginModule(java.lang.String ctxName,
                                          java.lang.String name,
                                          java.lang.String loginModuleClzName,
                                          java.lang.String controlFlag,
                                          boolean debug,
                                          boolean addRoles,
                                          PortableMap pm)
                       throws oracle.as.jmx.framework.exceptions.ManagementException
Function which will update an existing Login Module. It will first remove the old reference & then will create the Service Instance with the information passed. It will then create a reference to the created Service Instance
Parameters:
ctxName - Name of Context where the reference has to be updated. If null, the default Context is used
name - Name of the Login Module
loginModuleClzName - Class Name for the Login Module
controlFlag - Control Flag for the Login Module. Values are - required, requisite, sufficient, optional
debug - Flag to set the debug option
addRoles - Flag to set the add Roles option
pm - Map containing the other additional properties that needs to be configured. pass null if no additional properties are required
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

addSAMLLoginModule

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void addSAMLLoginModule(java.lang.String ctxName,
                                           java.lang.String name,
                                           java.lang.String controlFlag,
                                           boolean debug,
                                           boolean addRoles,
                                           PortableMap pm,
                                           java.lang.String[] arrIssuers)
                        throws oracle.as.jmx.framework.exceptions.ManagementException
Function to add a SAML Login Module to a Context. The loginModuleClassName can be passed in the PortableMap to specify the SAML Login Module class name; if not supplied, it defaults to oracle.security.jps.internal.jaas.module.saml.JpsSAMLLoginModule.
Parameters:
ctxName - Name of Context where the reference has to be created. If null, the default Context is used
name - Name that should be given to the Service Instance
controlFlag - Control Flag for the Login Module. Values are - required, requisite, sufficient, optional
debug - Flag to set the debug option
addRoles - Flag to set the add Roles option
pm - Map containing the other additional properties that needs to be configured. pass null if no additional properties are required
arrIssuers - Array which contains the name of the issuers in the right order
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updateSAMLLoginModule

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void updateSAMLLoginModule(java.lang.String ctxName,
                                              java.lang.String name,
                                              java.lang.String controlFlag,
                                              boolean debug,
                                              boolean addRoles,
                                              PortableMap pm,
                                              java.lang.String[] arrIssuers)
                           throws oracle.as.jmx.framework.exceptions.ManagementException
Function to update a SAML Login Module to a Context
Parameters:
ctxName - Name of Context where the reference has to be created. If null, the default Context is used
name - Name of the Instance that has to be updated
controlFlag - Control Flag for the Login Module. Values are - required, requisite, sufficient, optional
debug - Flag to set the debug option
addRoles - Flag to set the add Roles option
pm - Map containing the other additional properties that needs to be configured. pass null if no additional properties are required
arrIssuers - Array which contains the name of the issuers in the right order
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updateKerberosLoginModule

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void updateKerberosLoginModule(java.lang.String name,
                                                  java.lang.String controlFlag,
                                                  boolean debug,
                                                  boolean addRoles,
                                                  java.lang.String principal,
                                                  java.lang.String keyTabFile,
                                                  PortableMap pm)
                               throws oracle.as.jmx.framework.exceptions.ManagementException
Function to configure a Kerberos Login Module. If a kerberos login module with the name already exists in the Context, this function will update the Login module, else it will behave like an add. The values useKeyTab, storeKey & doNotPrompt can be passed in the PortableMap. In case these values are not passed, it defaults to true. This method can only be called in the Context of a Farm level Jps Config MBean.
Parameters:
name - Name that should be given to the Service Instance
controlFlag - Control Flag for the Login Module. Values are - required, requisite, sufficient, optional
debug - Flag to set the debug option
addRoles - Flag to set the add Roles option
principal - The name of the principal that should be used. It could be simple username such as "testuser" or a service name such as "host/testhost.eng.sun.com" . You can use principal option to set the principal when there are credentials for multiple principals in the keyTab or when you want a specific ticket cache only
keyTabFile - The file name of the keytab to get principal's secret key.
pm - Map containing the other additional properties that needs to be configured. pass null if no additional properties are required
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

addKeyStoreService

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void addKeyStoreService(java.lang.String ctxName,
                                           java.lang.String path,
                                           java.lang.String type,
                                           char[] password,
                                           java.lang.String signatureAlias,
                                           char[] signaturePassword,
                                           java.lang.String cryptAlias,
                                           char[] cryptPassword,
                                           PortableMap pm)
                        throws oracle.as.jmx.framework.exceptions.ManagementException
Method to add a Key Store Service to the Context
Parameters:
ctxName - Name of Context where the reference has to be created. If null, the default Context is used
path - Absolute path to the keystore
type - Type of keystore provider - allowed values are "JKS", "PKCS12", "ORACLE_WALLET", "PKCS11"
password - Password for keystore [optional]
signatureAlias - Name or alias for the key that is used for signing
signaturePassword - Password to access sign key[optional]
cryptAlias - Name or alias for the key that is used for decrypting request
cryptPassword - Password to access crypt key [optional]
pm - Map containing the other additional properties that needs to be configured. pass null if no additional properties are required
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeServiceType

void removeServiceType(java.lang.String ctxName,
                       java.lang.String type)
                       throws oracle.as.jmx.framework.exceptions.ManagementException
Method to remove a configured Service from the Context.
Parameters:
ctxName - Name of the Context where the Service should be removed. If null, the default Context is used
type - The type of the service which is to be removed.
Throws:
oracle.as.jmx.framework.exceptions.ManagementException
See Also:
JpsConfigMXBean.IDENTITY_STORE, JpsConfigMXBean.CREDENTIAL_STORE, JpsConfigMXBean.POLICY_STORE, JpsConfigMXBean.KEYSTORE, JpsConfigMXBean.AUDIT, JpsConfigMXBean.IGF_STORE

addLoginModule

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void addLoginModule(java.lang.String ctxName,
                                       java.lang.String name)
                    throws oracle.as.jmx.framework.exceptions.ManagementException
Function to add a Login Module to the Context whose service instance already exists.
Parameters:
ctxName - Name of Context where the reference has to be created. If null, the default Context is used
name - Name of the Login Module (Service Instance Name) which will be looked up and whose reference created
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeLoginModule

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void removeLoginModule(java.lang.String ctxName,
                                          java.lang.String name)
                       throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove the reference to a specific Login Module from a Context
Parameters:
ctxName - Name of Context where the reference has to be removed. If null, the default Context is used
name - Name of the Login Module (Service Instance Name) which will be looked up and whose reference removed
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

deleteLoginModule

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void deleteLoginModule(java.lang.String lmName)
                       throws oracle.as.jmx.framework.exceptions.ManagementException
Function to delete specific Login Module Service Instance from jps-config.xml file All the references to this service instance in all the contexts is also deleted.
Parameters:
lmName - Name of the Login Module (Service Instance Name) which will be looked up and removed
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getLoginModuleNames

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String[] getLoginModuleNames(java.lang.String ctxName)
                                       throws oracle.as.jmx.framework.exceptions.ManagementException
Function which will return all the Login Module Names within a Context
Parameters:
ctxName - Name of Context where the reference has to be removed. If null, the default Context is used
Returns:
String[] Array of Names
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getAllLoginModuleNames

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String[] getAllLoginModuleNames()
                                          throws oracle.as.jmx.framework.exceptions.ManagementException
Function to return all the Login Module names that exist in the configuration
Returns:
String[] Array of Names
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getLoginModule

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableLoginModule getLoginModule(java.lang.String name)
                                   throws oracle.as.jmx.framework.exceptions.ManagementException
Function to return information about a specific Login Module
Parameters:
name - Name of the Login Module (Service Instance Name) which will be looked up
Returns:
PortableLoginModule which contains the information about the login
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getServiceConfig

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableServiceInstance getServiceConfig(java.lang.String ctx,
                                                            java.lang.String serviceType)
                                         throws oracle.as.jmx.framework.exceptions.ManagementException
Function to return information about a specific Service Type for a Context
Parameters:
ctx - Name of the Context. If null, the default Context is used
serviceType - The type of the service.
Returns:
PortableServiceInstance which contains the information related to the service
Throws:
oracle.as.jmx.framework.exceptions.ManagementException
See Also:
JpsConfigMXBean.IDENTITY_STORE, JpsConfigMXBean.CREDENTIAL_STORE, JpsConfigMXBean.POLICY_STORE, JpsConfigMXBean.KEYSTORE, JpsConfigMXBean.AUDIT

getDefaultContext

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableContext getDefaultContext()
                                  throws oracle.as.jmx.framework.exceptions.ManagementException
Function to get the Default Context
Returns:
PortableContext Which is the default Context
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getProperty

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String getProperty(java.lang.String name)
                             throws oracle.as.jmx.framework.exceptions.ManagementException
Returns the global property associated with the specified name.
Parameters:
name - name of the property
Returns:
value associated with the specified name
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getAllProperties

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableMap getAllProperties()
                             throws oracle.as.jmx.framework.exceptions.ManagementException
Function to return all the Properties at the global level that are associated within this Configuration MBean
Returns:
PortableMap which contains the different Properties
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updateProperty

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
java.lang.String updateProperty(java.lang.String name,
                                                   java.lang.String value)
                                throws oracle.as.jmx.framework.exceptions.ManagementException
Function to update a Property at the global level. If the property does not exist, this function works like an addProperty and returns null.
Parameters:
name - Name of the Property
value - New Value that should be associated with the Property
Returns:
String The old value associated with the Name
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeProperty

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
java.lang.String removeProperty(java.lang.String name)
                                throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove a global Property
Parameters:
name - Name of the Property
Returns:
String which is the old value that was associated with the key. null if the property did not exist
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeAllProperties

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void removeAllProperties()
                         throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove all the Properties defined at the global level associated with the Configuration MBean
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getPropertySet

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortablePropertySet getPropertySet(java.lang.String name)
                                   throws oracle.as.jmx.framework.exceptions.ManagementException
Returns the global property set associated with the specified name
Parameters:
name - name of the desired property set
Returns:
A PortablePropertySet instance representing the set of properties
Throws:
oracle.as.jmx.framework.exceptions.ManagementException - associated with the specified name, or null if there exists no property sets with the given name.

getAllPropertySets

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortablePropertySet[] getAllPropertySets()
                                         throws oracle.as.jmx.framework.exceptions.ManagementException
Returns all the property sets defined at the global level
Returns:
PortablePropertySet[] which contains all the PropertySet
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updatePropertySet

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
PortablePropertySet updatePropertySet(java.lang.String name,
                                                         PortablePropertySet ps)
                                      throws oracle.as.jmx.framework.exceptions.ManagementException
Function to update a global PortablePropertySet. If the PortablePropertySet does not exist, this function works like an addPropertySet and returns null.
Parameters:
name - Name of the PortablePropertySet
ps - New Value that should be associated with the PortablePropertySet. The Old values are removed.
Returns:
PortablePropertySet The old value associated with the name
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removePropertySet

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
PortablePropertySet removePropertySet(java.lang.String name)
                                      throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove a global PortablePropertySet
Parameters:
name - Name of the PortablePropertySet
Returns:
PortablePropertySet which is the old value that was associated with the name. null if the property did not exist
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeAllPropertySets

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void removeAllPropertySets()
                           throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove all PortablePropertySets defined at the global level
Parameters:
name - Name of the PortablePropertySet
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getAllExtendedPropertySets

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableExtendedProperty[] getAllExtendedPropertySets()
                                                      throws oracle.as.jmx.framework.exceptions.ManagementException
Returns all the extended property sets
Returns:
PortableExtendedProperty[] array which contains all the Extended Properties
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getExtendedPropertySet

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableExtendedProperty getExtendedPropertySet(java.lang.String name)
                                                throws oracle.as.jmx.framework.exceptions.ManagementException
Returns the extended property associated with the specified name
Parameters:
name - name of the desired extended property set
Returns:
A PortableExtendedProperty instance representing the set of properties
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updateExtendedPropertySet

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
PortableExtendedProperty updateExtendedPropertySet(java.lang.String name,
                                                                      PortableExtendedProperty ps)
                                                   throws oracle.as.jmx.framework.exceptions.ManagementException
Function to update a PortableExtendedProperty. If the PortableExtendedProperty does not exist, this function works like an addPropertySet and returns null.
Parameters:
name - Name of the PortableExtendedProperty
ps - New Value that should be associated with the PortableExtendedProperty. The Old values are removed.
Returns:
PortableExtendedProperty The old value associated with the name. null if the property did not exist
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeExtendedPropertySet

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
PortableExtendedProperty removeExtendedPropertySet(java.lang.String name)
                                                   throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove a PortableExtendedProperty
Parameters:
name - Name of the PortableExtendedProperty
Returns:
PortableExtendedProperty which is the old value that was associated with the name. null if the property did not exist
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeAllExtendedPropertySets

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void removeAllExtendedPropertySets()
                                   throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove all PortableExtendedProperty
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updateServiceInstanceProperty

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
java.lang.String updateServiceInstanceProperty(java.lang.String siName,
                                                                  java.lang.String name,
                                                                  java.lang.String value)
                                               throws oracle.as.jmx.framework.exceptions.ManagementException
Function which will update a property within a Service Instance. If the property with the said name does not exist this method behaves like as an add
Parameters:
siName - Name of the Service Instance where the data has to be changed
name - Name of the property
value - New value of the property
Returns:
String the old value associated with the property.null if the property did not exist
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeServiceInstanceProperty

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
java.lang.String removeServiceInstanceProperty(java.lang.String siName,
                                                                  java.lang.String name)
                                               throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove a property within a Service Instance
Parameters:
siName - Name of the Service Instance where the data has to be changed
name - Name of the property
Returns:
String value associated with the name.
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

updateServiceInstanceExtendedProperty

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
PortableExtendedPropertyType updateServiceInstanceExtendedProperty(java.lang.String siName,
                                                                                      PortableExtendedPropertyType value)
                                                                   throws oracle.as.jmx.framework.exceptions.ManagementException
Function which will update (over writes) a extended property within a Service Instance. If the extended property with the same name does not exist this method behaves like as an add
Parameters:
siName - Name of the Service Instance where the data has to be changed
value - The Extended Property that should be added/updated
Returns:
PortableExtendedPropertyType The old value associated. null if the property did not exist
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeServiceInstanceExtendedProperty

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
PortableExtendedPropertyType removeServiceInstanceExtendedProperty(java.lang.String siName,
                                                                                      java.lang.String name)
                                                                   throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove a extended property within a Service Instance
Parameters:
siName - Name of the Service Instance where the data has to be changed
name - Name of the extended property
Returns:
PortableExtendedPropertyType The old value associated.
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getContext

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableContext getContext(java.lang.String name)
                           throws oracle.as.jmx.framework.exceptions.ManagementException
Function to get a specific Context.
Returns:
PortableContext Which is the default Context
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

addExtendedPropertySetRefToServiceInstance

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
void addExtendedPropertySetRefToServiceInstance(java.lang.String serviceInstName,
                                                                   java.lang.String extPropSetRef)
                                                throws oracle.as.jmx.framework.exceptions.ManagementException
Function to add an extended property set reference to a specific Service Instance
Parameters:
serviceInstName - Name of the Service Instance that should be updated
extPropSetRef - Name of the extended property reference that should be added to the Service Instance
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeExtendedPropertySetRefToServiceInstance

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
void removeExtendedPropertySetRefToServiceInstance(java.lang.String serviceInstName,
                                                                      java.lang.String extPropSetRef)
                                                   throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove an extended property set reference from a Service Instance
Parameters:
serviceInstName - Name of the Service Instance that should be updated
extPropSetRef - Name of the extended property reference that should be removed to the Service Instance
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

addPropertySetRefToServiceInstance

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
void addPropertySetRefToServiceInstance(java.lang.String serviceInstName,
                                                           java.lang.String propSetRef)
                                        throws oracle.as.jmx.framework.exceptions.ManagementException
Function to add a property set reference to a specific Service Instance
Parameters:
serviceInstName - Name of the Service Instance that should be updated
propSetRef - Name of the property reference that should be added to the Service Instance
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removePropertySetRefToServiceInstance

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
void removePropertySetRefToServiceInstance(java.lang.String serviceInstName,
                                                              java.lang.String propSetRef)
                                           throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove a property set reference from a Service Instance
Parameters:
serviceInstName - Name of the Service Instance that should be updated
propSetRef - Name of the property reference that should be removed to the Service Instance
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

addServiceInstanceRefsToServiceInstance

void addServiceInstanceRefsToServiceInstance(java.lang.String serviceInstName,
                                             java.lang.String[] servInstanceRefNames)
                                             throws oracle.as.jmx.framework.exceptions.ManagementException
Function to add child service instances to a specific Service Instance
Parameters:
serviceInstName - Name of the Service Instance that should be updated
servInstanceRefNames - Names of the child service instances that should be added to the Service Instance
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

removeServiceInstanceRefsFromServiceInstance

void removeServiceInstanceRefsFromServiceInstance(java.lang.String serviceInstName,
                                                  java.lang.String[] servInstanceRefNames)
                                                  throws oracle.as.jmx.framework.exceptions.ManagementException
Function to remove child service instances from a specific Service Instance
Parameters:
serviceInstName - Name of the Service Instance that should be updated
servInstanceRefNames - Names of the child service instances that should be removed from the Service Instance
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

checkServiceSetUp

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
@Deprecated
boolean checkServiceSetUp(PortableMap mp,
                                                        java.lang.String serviceType)
                          throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. As of release 11gR1, replaced by JpsConfigMXBean.checkServiceSetUp(String, char[], PortableMap, String) Function to check pre-requisites that are required for setting up the service.
Parameters:
mp - a PortableMap to capture the target security store configuration information; For LDAP server, supported keys in the map are: "domain"; "jpsroot";"admin";"password"; "servertype"; "ldapurl";"groupbase"; "userbase"; For DataBase server, supported keys in the map are: "domain";"jpsroot";"admin";"password"; "servertype"; "datasourcename";
serviceType - type of the service needs to checked, supported types are: JpsConfigMXBean.CREDENTIAL_STORE, JpsConfigMXBean.POLICY_STORE and JpsConfigMXBean.KEYSTORE
Returns:
boolean, true when the server is ready for the service setup, false otherwise
Throws:
oracle.as.jmx.framework.exceptions.ManagementException
See Also:
#checkServiceSetUp(String, char[], PortableMap, String)}

checkServiceSetUp

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void checkServiceSetUp(java.lang.String userName,
                                          char[] password,
                                          PortableMap mp,
                                          java.lang.String serviceType)
                       throws oracle.as.jmx.framework.exceptions.ManagementException
Function to check pre-requisites that are required for setting up the service.

Follow the below mentioned steps to re-associate a service. The target security store can be LDAP or Database:
1. JpsConfigMXBean.checkServiceSetUp(String, char[], PortableMap, String)
2. JpsConfigMXBean.checkAndSeedSchema()
3. JpsConfigMXBean.migrateData()
4. JpsConfigMXBean.testJpsService()
5. JpsConfigMXBean.updateLDAPReassociationConfiguration()

Parameters:
userName - the admin name - cannot be null for LDAP store, optional for the data source based database configuration
password - the admin credential - cannot be null for LDAP store, optional for data source based database configuration
mp - a PortableMap to capture the target security store configuration information; For LDAP store, mandatory keys are: "domain";"jpsroot";"servertype"; "ldapurl". For Database store, mandatory keys are: "domain";"jpsroot";"servertype","datasourcename";
serviceType - type of the service which needs to checked, supported types are JpsConfigMXBean.CREDENTIAL_STORE, JpsConfigMXBean.POLICY_STORE and JpsConfigMXBean.KEYSTORE
Throws:
oracle.as.jmx.framework.exceptions.ManagementException - the underlying exception message from server side

checkAndSeedSchema

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void checkAndSeedSchema()
                        throws oracle.as.jmx.framework.exceptions.ManagementException
Function to check if the schema is seeded in the target security store. If not, the schema is loaded into the LDAP store. In case of database, schema seeding is a pre-requisite to re-associate a service, and exception is thrown if schema not existing.
Prerequisite: JpsConfigMXBean.checkServiceSetUp(String, char[], PortableMap, String) needs to be called to check if the server is set up
Throws:
oracle.as.jmx.framework.exceptions.ManagementException - the underlying exception message from server side

migrateData

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void migrateData()
                 throws oracle.as.jmx.framework.exceptions.ManagementException
Function to migrate data from the existing security store to the target store.
Prerequisite: JpsConfigMXBean.checkAndSeedSchema() needs to be called to ensured that appropriate schema exists in the target store.
Throws:
oracle.as.jmx.framework.exceptions.ManagementException - the underlying exception message from server side

testJpsService

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void testJpsService()
                    throws oracle.as.jmx.framework.exceptions.ManagementException
Function to validate the service after data migration.
Prerequisite: JpsConfigMXBean.migrateData() needs to be called for CREDENTIAL_STORE, POLICY_STORE and KEYSTORE service testing
Throws:
oracle.as.jmx.framework.exceptions.ManagementException - the underlying exception message from server side

updateLDAPReassociationConfiguration

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void updateLDAPReassociationConfiguration()
                                          throws oracle.as.jmx.framework.exceptions.ManagementException
Function to update jps-config.xml after successful re-association to the target security store.
Prerequisite: JpsConfigMXBean.testJpsService() should pass without exception
Throws:
oracle.as.jmx.framework.exceptions.ManagementException - the underlying exception message from server side

configureSSO

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void configureSSO(java.lang.String ctx,
                                     PortableMap authURIProps,
                                     PortableMap authLevelProps,
                                     PortableMap serviceProps)
                  throws oracle.as.jmx.framework.exceptions.ManagementException
Function to configure SSO service in the specified context
Parameters:
ctx - Jps Context to which this service has to be added
authURIProps - The auth URI properties for SSO service
authLevelProps - The auth Level properties for SSO service
serviceProps - The service level properties for SSO other than above properties
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

importAuditConfig

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
@Deprecated
PortableAuditConfig importAuditConfig(java.lang.String auditConfig)
                                      throws oracle.as.jmx.framework.exceptions.ManagementException,
                                             java.io.IOException,
                                             java.text.ParseException
Deprecated. Returns the audit configuration structure
Returns:
PortableAuditConfig A list of all the audit configuration properties
Throws:
ManagementException,IOException
oracle.as.jmx.framework.exceptions.ManagementException
java.io.IOException
java.text.ParseException

exportAuditConfig

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
@Deprecated
java.lang.String exportAuditConfig(java.lang.String filterPreset,
                                                                 java.lang.String specialUsers,
                                                                 java.lang.String customEvents)
                                   throws java.io.IOException
Deprecated. Returns the audit configuration
Parameters:
filterPreset - The auditing level
specialUsers - List of users for whom auditing is always enabled
customEvents - List of events to be audited if filterPreset is Custom s
Returns:
String A list of all the audit configuration properties
Throws:
java.io.IOException

getAuditConfiguration

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
PortableAuditConfig getAuditConfiguration()
                                          throws oracle.as.jmx.framework.exceptions.ManagementException,
                                                 java.text.ParseException
Returns the audit configuration structure
Returns:
PortableAuditConfig A list of all the audit configuration properties
Throws:
ManagementException,ParseException
oracle.as.jmx.framework.exceptions.ManagementException
java.text.ParseException

setAuditConfiguration

void setAuditConfiguration(PortableAuditConfig auditConfig)
                           throws oracle.as.jmx.framework.exceptions.ManagementException
Sets the audit configuration structure
Parameters:
PortableAuditConfig - A list of all the audit configuration properties
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

validateExpression

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
@Deprecated
void validateExpression(java.lang.String componentType,
                                                      java.lang.String eventName,
                                                      java.lang.String expression)
                        throws java.text.ParseException
Deprecated. Validates the filter expression
Parameters:
componentType - The component whose event needs to be checked
eventName - Event for which the expression needs to be validated
expression - Expression that is to be validated
Throws:
java.text.ParseException

validateAuditDataSources

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
@Deprecated
java.lang.String[] validateAuditDataSources(java.lang.String[] jndi)
Deprecated. Validates the audit data sources
Parameters:
jndis - List of jndi names to be validated
Returns:
String[] An array of valid audit data sources
Throws:
java.text.ParseException

getAuditLoaderConfiguration

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
PortableAuditLoaderConfig getAuditLoaderConfiguration()
                                                      throws oracle.as.jmx.framework.exceptions.ManagementException
Returns the audit loader configuration structure
Returns:
PortableAuditLoaderConfig A list of all the audit loader properties
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

setAuditLoaderConfiguration

void setAuditLoaderConfiguration(PortableAuditLoaderConfig auditLoaderConfig)
                                 throws oracle.as.jmx.framework.exceptions.ManagementException
Sets the audit loader configuration structure
Parameters:
PortableAuditLoaderConfig - A list of all the audit loader properties
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getComponentEvents

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableComponentEvents[] getComponentEvents(java.lang.String language)
Deprecated. Gets the component events of all components for audit service
Parameters:
language - Language in which the display name, help text will be displayed
Returns:
PortableComponentEvents An array which contains the event definitions for all the components

getFilterPreset

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
java.lang.String getFilterPreset()
                                 throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Returns the filter preset for audit service
Returns:
String The auditing level
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getMaxLogFileSize

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
long getMaxLogFileSize()
                       throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Returns the max log file size for audit log file
Returns:
long The max log file size for audit
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getMaxLogDirSize

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
long getMaxLogDirSize()
                      throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Returns the max log directory size for audit logs
Returns:
long The max log directory size for audit logs
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getCustomEvents

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
java.lang.String getCustomEvents()
                                 throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Returns the custom events for audit service
Returns:
String A list of custom events
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

getSpecialUsers

@Description(resourceKey=<error>,
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
java.lang.String getSpecialUsers()
                                 throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Returns the special users for audit service
Returns:
String List of special users for audit
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

setFilterPreset

void setFilterPreset(java.lang.String filterPreset)
                     throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Sets the filter preset for audit service
Parameters:
filterPreset - The auditing level
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

setMaxLogFileSize

void setMaxLogFileSize(long maxLogFileSize)
                       throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Sets the max log file size for audit log
Parameters:
maxLogFileSize - The max log file size for audit
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

setMaxLogDirSize

void setMaxLogDirSize(long maxLogDirSize)
                      throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Sets the max log directory size for audit logs
Parameters:
maxLogDirSize - The max log directory size for audit logs
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

setSpecialUsers

void setSpecialUsers(java.lang.String specialUsers)
                     throws oracle.as.jmx.framework.exceptions.ManagementException
Deprecated. Sets the special users for audit service
Parameters:
specialUsers - List for special users for audit
Throws:
oracle.as.jmx.framework.exceptions.ManagementException

setCustomEvents

void setCustomEvents(java.lang.String customEvents)
                     throws oracle.as.jmx.framework.exceptions.ManagementException,
                            java.text.ParseException
Deprecated. Sets the custom events for audit service
Parameters:
customEvents - List of custom events for audit
Throws:
oracle.as.jmx.framework.exceptions.ManagementException
java.text.ParseException

updateTrustServiceConfig

void updateTrustServiceConfig(java.lang.String ctxName,
                              java.lang.String providerName,
                              PortableMap pMap)
                              throws oracle.as.jmx.framework.exceptions.ManagementException
Updates Trust Service provider configuration
Parameters:
ctxName - JPS context name
providerName - The provider name
pMap - Provider specific configuration properties
Throws:
oracle.as.jmx.framework.exceptions.ManagementException - When updating provider configuration fails

Skip navigation links

Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services
11g Release 1 (11.1.1)

E14651-04


Copyright © 2011, Oracle. All rights reserved.