|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.description",
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, java.lang.String componentType) 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 |
importAuditConfig(java.lang.String auditConfig, java.lang.String componentType) |
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 |
SetOptionalReassociationConfigParam(java.lang.String paramName, char[] value) Function to set parameters which can be used during reassociation. |
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 |
---|
static final java.lang.String RBN
static final java.lang.String AES_128_CBC
static final java.lang.String AES_192_CBC
static final java.lang.String AES_256_CBC
static final java.lang.String DES_EDE_CBC
static final java.lang.String OID
static final java.lang.String ACTIVE_DIRECTORY
static final java.lang.String IPLANET
static final java.lang.String EDIRECTORY
static final java.lang.String OPEN_LDAP
static final java.lang.String COREID
static final java.lang.String IDENTITY_STORE
static final java.lang.String CREDENTIAL_STORE
static final java.lang.String POLICY_STORE
static final java.lang.String IGF_STORE
static final java.lang.String IDM
static final java.lang.String ANONYMOUS
static final java.lang.String KEYSTORE
static final java.lang.String AUDIT
static final java.lang.String SSO
Method Detail |
---|
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.persist",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void persist()
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsConfiguration
object.oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.refresh",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void refresh()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.addFileBasedIdentityStoreToContext",
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
fileName
- Name of the file which has to be referenced by the servicerealmName
- Name of the default realm for this identity storectxName
- Name of the Context where the service is to be addedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.addFileBasedPolicyStoreToContext",
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
fileName
- Name of the file which has to be referenced by the servicectxName
- Name of the Context where the service is to be addedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.addFileBasedCredentialStoreToContext",
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
fileName
- Name of the file which has to be referenced by the servicectxName
- Name of the Context where the service is to be addedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.testLDAPConnection",
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
host
- LDAP Server hostport
- Port to connect touserDN
- Distinguished Name of the User (cn=admin)password
- Passwordoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.testLDAPConnection",
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
url
- The url which is of the form ldap://host:port for non-secure and ldaps://host:port for secureuserDN
- Distinguished Name of the User (cn=admin)password
- Passwordoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.testJpsRootDN",
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
host
- LDAP Server hostport
- Port to connect touserDN
- Distinguished Name of the User (cn=admin)password
- PasswordJpsRootDN
- JpsRootDN that needs to validatedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.testJpsRootDN",
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
url
- The url which is of the form ldap://host:port for non-secure and ldaps://host:port for secureuserDN
- Distinguished Name of the User (cn=admin)password
- PasswordjpsRootDN
- JpsRootDN that needs to validatedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.configureLDAPIdentityStore",
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
ctxName
- The Name of the Context where the configuration should be done. If null, then the configuration is made to the default ContextadminDN
- 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 specifiymp
- Map containing the other additional properties that needs to be configured. Eg. SSL etc pass null
if no additional properties are requiredserviceInstNames
- names of other child service instances representing LDAP servers behind the libOvdoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.configureLDAPIdentityStore",
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
ldapURL
- URL which should be used to connect to the LDAP Server. Format is host:portadminDN
- The Distinguished name of the Adminpassword
- Password for the Admintype
- Type of the LDAP Server (Eg. OID)subscriberName
- Subscriber NamearrUsrSearchBase
- Array which contains the Search base for the UserarrGrpSearchBase
- Array which contains the Search base for the Groupmp
- Map containing the other additional properties that needs to be configured. Eg. SSL etc pass null
if no additional properties are requiredserviceInstNames
- names of other service instances which to be referencedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.configureLDAPIdentityStore",
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
ldapURL
- URL which should be used to connect to the LDAP Server. Format is host:portalias
- Alias of the Credentialkey
- Key for the Credentialtype
- Type of the LDAP Server (Eg. OID)subscriberName
- Subscriber NamearrUsrSearchBase
- Array which contains the Search base for the UserarrGrpSearchBase
- Array which contains the Search base for the Groupmp
- Map containing the other additional properties that needs to be configured. Eg. SSL etc pass null
if no additional properties are requiredoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.configureLdapCSFStore",
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
ctxName
- The Name of the Context where the configuration should be done. If null, then the configuration is made to the default ContextldapURL
- URL which should be used to connect to the LDAP Server. Format is host:portadminDN
- The Distinguished name of the Adminpassword
- Password for the AdminsubscriberName
- Subscriber Namemp
- Map containing the other additional properties that needs to be configured. Eg. SSL etc pass null
if no additional properties are requiredoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.configureLdapPolicyStore",
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
ctxName
- The Name of the Context where the configuration should be done. If null, then the configuration is made to the default ContextldapURL
- URL which should be used to connect to the LDAP Server. Format is host:portadminDN
- The Distinguished name of the Adminpassword
- Password for the Adminmp
- Map containing the other additional properties that needs to be configured. Eg. SSL etc pass null
if no additional properties are requiredoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.addNewLoginModule",
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
ctxName
- Name of Context where the reference has to be created. If null, the default Context is usedname
- Name of the Login ModuleloginModuleClzName
- Class Name for the Login ModulecontrolFlag
- Control Flag for the Login Module. Values are - required, requisite, sufficient, optionaldebug
- Flag to set the debug optionaddRoles
- Flag to set the add Roles optionpm
- Map containing the other additional properties that needs to be configured. pass null
if no additional properties are requiredoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.updateLoginModule",
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
ctxName
- Name of Context where the reference has to be updated. If null, the default Context is usedname
- Name of the Login ModuleloginModuleClzName
- Class Name for the Login ModulecontrolFlag
- Control Flag for the Login Module. Values are - required, requisite, sufficient, optionaldebug
- Flag to set the debug optionaddRoles
- Flag to set the add Roles optionpm
- Map containing the other additional properties that needs to be configured. pass null
if no additional properties are requiredoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.addSAMLLoginModule",
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
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
.ctxName
- Name of Context where the reference has to be created. If null, the default Context is usedname
- Name that should be given to the Service InstancecontrolFlag
- Control Flag for the Login Module. Values are - required, requisite, sufficient, optionaldebug
- Flag to set the debug optionaddRoles
- Flag to set the add Roles optionpm
- Map containing the other additional properties that needs to be configured. pass null
if no additional properties are requiredarrIssuers
- Array which contains the name of the issuers in the right orderoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.updateSAMLLoginModule",
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
ctxName
- Name of Context where the reference has to be created. If null, the default Context is usedname
- Name of the Instance that has to be updatedcontrolFlag
- Control Flag for the Login Module. Values are - required, requisite, sufficient, optionaldebug
- Flag to set the debug optionaddRoles
- Flag to set the add Roles optionpm
- Map containing the other additional properties that needs to be configured. pass null
if no additional properties are requiredarrIssuers
- Array which contains the name of the issuers in the right orderoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.updateKerberosLoginModule",
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
name
- Name that should be given to the Service InstancecontrolFlag
- Control Flag for the Login Module. Values are - required, requisite, sufficient, optionaldebug
- Flag to set the debug optionaddRoles
- Flag to set the add Roles optionprincipal
- 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 onlykeyTabFile
- 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 requiredoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.addKeyStoreService",
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
ctxName
- Name of Context where the reference has to be created. If null, the default Context is usedpath
- Absolute path to the keystoretype
- 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 signingsignaturePassword
- Password to access sign key[optional]cryptAlias
- Name or alias for the key that is used for decrypting requestcryptPassword
- 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 requiredoracle.as.jmx.framework.exceptions.ManagementException
void removeServiceType(java.lang.String ctxName, java.lang.String type) throws oracle.as.jmx.framework.exceptions.ManagementException
ctxName
- Name of the Context where the Service should be removed. If null, the default Context is usedtype
- The type of the service which is to be removed.oracle.as.jmx.framework.exceptions.ManagementException
JpsConfigMXBean.IDENTITY_STORE
, JpsConfigMXBean.CREDENTIAL_STORE
, JpsConfigMXBean.POLICY_STORE
, JpsConfigMXBean.KEYSTORE
, JpsConfigMXBean.AUDIT
, JpsConfigMXBean.IGF_STORE
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.addLoginModule",
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
ctxName
- Name of Context where the reference has to be created. If null, the default Context is usedname
- Name of the Login Module (Service Instance Name) which will be looked up and whose reference createdoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removeLoginModule",
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
ctxName
- Name of Context where the reference has to be removed. If null, the default Context is usedname
- Name of the Login Module (Service Instance Name) which will be looked up and whose reference removedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.deleteLoginModule",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void deleteLoginModule(java.lang.String lmName)
throws oracle.as.jmx.framework.exceptions.ManagementException
lmName
- Name of the Login Module (Service Instance Name) which will be looked up and removedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getLoginModuleNames",
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
ctxName
- Name of Context where the reference has to be removed. If null, the default Context is usedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getAllLoginModuleNames",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String[] getAllLoginModuleNames()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getLoginModule",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableLoginModule getLoginModule(java.lang.String name)
throws oracle.as.jmx.framework.exceptions.ManagementException
name
- Name of the Login Module (Service Instance Name) which will be looked uporacle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getServiceConfig",
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
ctx
- Name of the Context. If null, the default Context is usedserviceType
- The type of the service.oracle.as.jmx.framework.exceptions.ManagementException
JpsConfigMXBean.IDENTITY_STORE
, JpsConfigMXBean.CREDENTIAL_STORE
, JpsConfigMXBean.POLICY_STORE
, JpsConfigMXBean.KEYSTORE
, JpsConfigMXBean.AUDIT
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getDefaultContext",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableContext getDefaultContext()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getProperty",
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
name
- name of the propertyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getAllProperties",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableMap getAllProperties()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.updateProperty",
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
null
.name
- Name of the Propertyvalue
- New Value that should be associated with the Propertyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removeProperty",
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
name
- Name of the Propertynull
if the property did not existoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removeAllProperties",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void removeAllProperties()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getPropertySet",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortablePropertySet getPropertySet(java.lang.String name)
throws oracle.as.jmx.framework.exceptions.ManagementException
name
- name of the desired property setoracle.as.jmx.framework.exceptions.ManagementException
- associated with the specified name, or null
if there exists no property sets with the given name.
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getAllPropertySets",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortablePropertySet[] getAllPropertySets()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.updatePropertySet",
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
null
.name
- Name of the PortablePropertySetps
- New Value that should be associated with the PortablePropertySet. The Old values are removed.oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removePropertySet",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
PortablePropertySet removePropertySet(java.lang.String name)
throws oracle.as.jmx.framework.exceptions.ManagementException
name
- Name of the PortablePropertySetnull
if the property did not existoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removeAllPropertySets",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void removeAllPropertySets()
throws oracle.as.jmx.framework.exceptions.ManagementException
name
- Name of the PortablePropertySetoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getAllExtendedProperties",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableExtendedProperty[] getAllExtendedPropertySets()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getExtendedProperty",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableExtendedProperty getExtendedPropertySet(java.lang.String name)
throws oracle.as.jmx.framework.exceptions.ManagementException
name
- name of the desired extended property setoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.updateExtendedProperty",
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
name
- Name of the PortableExtendedPropertyps
- New Value that should be associated with the PortableExtendedProperty. The Old values are removed.null
if the property did not existoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removeExtendedProperty",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
PortableExtendedProperty removeExtendedPropertySet(java.lang.String name)
throws oracle.as.jmx.framework.exceptions.ManagementException
name
- Name of the PortableExtendedPropertynull
if the property did not existoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removeAllExtendedProperties",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void removeAllExtendedPropertySets()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.updateServiceInstanceProperty",
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
siName
- Name of the Service Instance where the data has to be changedname
- Name of the propertyvalue
- New value of the propertynull
if the property did not existoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removeServiceInstanceProperty",
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
siName
- Name of the Service Instance where the data has to be changedname
- Name of the propertyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.updateServiceInstanceExtendedProperty",
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
siName
- Name of the Service Instance where the data has to be changedvalue
- The Extended Property that should be added/updatednull
if the property did not existoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removeServiceInstanceExtendedProperty",
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
siName
- Name of the Service Instance where the data has to be changedname
- Name of the extended propertyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getContext",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableContext getContext(java.lang.String name)
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.addExtendedPropertySetRefToServiceInstance",
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
serviceInstName
- Name of the Service Instance that should be updatedextPropSetRef
- Name of the extended property reference that should be added to the Service Instanceoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removeExtendedPropertySetRefToServiceInstance",
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
serviceInstName
- Name of the Service Instance that should be updatedextPropSetRef
- Name of the extended property reference that should be removed to the Service Instanceoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.addPropertySetRefToServiceInstance",
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
serviceInstName
- Name of the Service Instance that should be updatedpropSetRef
- Name of the property reference that should be added to the Service Instanceoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.removePropertySetRefToServiceInstance",
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
serviceInstName
- Name of the Service Instance that should be updatedpropSetRef
- Name of the property reference that should be removed to the Service Instanceoracle.as.jmx.framework.exceptions.ManagementException
void addServiceInstanceRefsToServiceInstance(java.lang.String serviceInstName, java.lang.String[] servInstanceRefNames) throws oracle.as.jmx.framework.exceptions.ManagementException
serviceInstName
- Name of the Service Instance that should be updatedservInstanceRefNames
- Names of the child service instances that should be added to the Service Instanceoracle.as.jmx.framework.exceptions.ManagementException
void removeServiceInstanceRefsFromServiceInstance(java.lang.String serviceInstName, java.lang.String[] servInstanceRefNames) throws oracle.as.jmx.framework.exceptions.ManagementException
serviceInstName
- Name of the Service Instance that should be updatedservInstanceRefNames
- Names of the child service instances that should be removed from the Service Instanceoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.checkServiceSetUp",
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
JpsConfigMXBean.checkServiceSetUp(String, char[], PortableMap, String)
Function to check pre-requisites that are required for setting up the service.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
oracle.as.jmx.framework.exceptions.ManagementException
#checkServiceSetUp(String, char[], PortableMap, String)}
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.checkServiceSetUp",
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
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()
userName
- the admin name - cannot be null for LDAP store, optional for the data source based database configurationpassword
- the admin credential - cannot be null for LDAP store, optional for data source based database configurationmp
- 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
oracle.as.jmx.framework.exceptions.ManagementException
- the underlying exception message from server side
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.checkAndSeedSchema",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void checkAndSeedSchema()
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsConfigMXBean.checkServiceSetUp(String, char[], PortableMap, String)
needs to be called to check if the server is set uporacle.as.jmx.framework.exceptions.ManagementException
- the underlying exception message from server side
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.migrateData",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void migrateData()
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsConfigMXBean.checkAndSeedSchema()
needs to be called to ensured that appropriate schema exists in the target store.oracle.as.jmx.framework.exceptions.ManagementException
- the underlying exception message from server side
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.testJpsService",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void testJpsService()
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsConfigMXBean.migrateData()
needs to be called for CREDENTIAL_STORE, POLICY_STORE and KEYSTORE service testingoracle.as.jmx.framework.exceptions.ManagementException
- the underlying exception message from server side
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.SetOptionalReassociationConfigParam",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void SetOptionalReassociationConfigParam(java.lang.String paramName,
char[] value)
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsConfigMXBean.checkServiceSetUp(String, char[], PortableMap, String)
oracle.as.jmx.framework.exceptions.ManagementException
- the underlying exception message from server side
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.updateLDAPReassociationConfiguration",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void updateLDAPReassociationConfiguration()
throws oracle.as.jmx.framework.exceptions.ManagementException
JpsConfigMXBean.testJpsService()
should pass without exceptionoracle.as.jmx.framework.exceptions.ManagementException
- the underlying exception message from server side
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.configureSSO",
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
ctx
- Jps Context to which this service has to be addedauthURIProps
- The auth URI properties for SSO serviceauthLevelProps
- The auth Level properties for SSO serviceserviceProps
- The service level properties for SSO other than above propertiesoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.importAuditConfig",
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
ManagementException,IOException
oracle.as.jmx.framework.exceptions.ManagementException
java.io.IOException
java.text.ParseException
void importAuditConfig(java.lang.String auditConfig, java.lang.String componentType) throws oracle.as.jmx.framework.exceptions.ManagementException, java.io.IOException, java.text.ParseException, oracle.security.audit.AuditException, oracle.security.jps.JpsException
oracle.as.jmx.framework.exceptions.ManagementException
java.io.IOException
java.text.ParseException
oracle.security.audit.AuditException
oracle.security.jps.JpsException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.importAuditConfig",
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,
java.lang.String componentType)
throws java.io.IOException,
oracle.security.audit.AuditException
filterPreset
- The auditing levelspecialUsers
- List of users for whom auditing is always enabledcustomEvents
- List of events to be audited if filterPreset is Custom sjava.io.IOException
oracle.security.audit.AuditException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.AuditConfiguration",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
PortableAuditConfig getAuditConfiguration()
throws oracle.as.jmx.framework.exceptions.ManagementException,
java.text.ParseException
ManagementException,ParseException
oracle.as.jmx.framework.exceptions.ManagementException
java.text.ParseException
void setAuditConfiguration(PortableAuditConfig auditConfig) throws oracle.as.jmx.framework.exceptions.ManagementException
PortableAuditConfig
- A list of all the audit configuration propertiesoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.validateExpression",
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
componentType
- The component whose event needs to be checkedeventName
- Event for which the expression needs to be validatedexpression
- Expression that is to be validatedjava.text.ParseException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.validateAuditDataSources",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
@Deprecated
java.lang.String[] validateAuditDataSources(java.lang.String[] jndi)
jndis
- List of jndi names to be validatedjava.text.ParseException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.AuditLoaderConfiguration",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
PortableAuditLoaderConfig getAuditLoaderConfiguration()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
void setAuditLoaderConfiguration(PortableAuditLoaderConfig auditLoaderConfig) throws oracle.as.jmx.framework.exceptions.ManagementException
PortableAuditLoaderConfig
- A list of all the audit loader propertiesoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getComponentEvents",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableComponentEvents[] getComponentEvents(java.lang.String language)
language
- Language in which the display name, help text will be displayed
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.FilterPreset",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
java.lang.String getFilterPreset()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.MaxLogFileSize",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
long getMaxLogFileSize()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.MaxLogDirSize",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
long getMaxLogDirSize()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.CustomEvents",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
java.lang.String getCustomEvents()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.SpecialUsers",
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
java.lang.String getSpecialUsers()
throws oracle.as.jmx.framework.exceptions.ManagementException
oracle.as.jmx.framework.exceptions.ManagementException
void setFilterPreset(java.lang.String filterPreset) throws oracle.as.jmx.framework.exceptions.ManagementException
filterPreset
- The auditing leveloracle.as.jmx.framework.exceptions.ManagementException
void setMaxLogFileSize(long maxLogFileSize) throws oracle.as.jmx.framework.exceptions.ManagementException
maxLogFileSize
- The max log file size for auditoracle.as.jmx.framework.exceptions.ManagementException
void setMaxLogDirSize(long maxLogDirSize) throws oracle.as.jmx.framework.exceptions.ManagementException
maxLogDirSize
- The max log directory size for audit logsoracle.as.jmx.framework.exceptions.ManagementException
void setSpecialUsers(java.lang.String specialUsers) throws oracle.as.jmx.framework.exceptions.ManagementException
specialUsers
- List for special users for auditoracle.as.jmx.framework.exceptions.ManagementException
void setCustomEvents(java.lang.String customEvents) throws oracle.as.jmx.framework.exceptions.ManagementException, java.text.ParseException
customEvents
- List of custom events for auditoracle.as.jmx.framework.exceptions.ManagementException
java.text.ParseException
void updateTrustServiceConfig(java.lang.String ctxName, java.lang.String providerName, PortableMap pMap) throws oracle.as.jmx.framework.exceptions.ManagementException
ctxName
- JPS context nameproviderName
- The provider namepMap
- Provider specific configuration propertiesoracle.as.jmx.framework.exceptions.ManagementException
- When updating provider configuration fails
|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |