JpsCredentialMXBean (Oracle Fusion Middleware Management Java API Reference for Oracle Platform Security Services)

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.description",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @ImmutableInfo(value="true")
 @Since(value="11.1.1.0.0")
 @Visibility(value=Advanced)
 @SystemMBean
 @MBeanRequiredGlobalSecurityRole(value=Admin)
public interface JpsCredentialMXBean

This interface defines the operations for CredentialStore management complying to JMX standards

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String RBN

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`RBN`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`assignGenericCredential(java.lang.String alias, java.lang.String credKey, java.io.Serializable cred, java.lang.String desc)` Assigns the Generic Credential to the specified alias and credKey.
`boolean`	`containsCredential(java.lang.String alias, java.lang.String credKey)` Returns `true` if an entry associated with the specified alias for this key `exist` in this store.
`boolean`	`containsMap(java.lang.String alias)` Returns `true` if an map associated with the specified alias `exist` in this store, false otherwise.
`void`	`deleteAllCredentials()` Removes all the `Credential` objects associated with the specified `alias` and `credKey`.
`void`	`deleteCredential(java.lang.String alias, java.lang.String credKey)` Removes the `Credential` objects associated with the specified `alias` and `credKey`.
`void`	`deleteCredentialMap(java.lang.String alias)` Removes the `Credential` objects associated with the specified `alias`.
`java.util.Set<java.lang.String>`	`getAliases()` Returns the `Set` of all the available `alias`.
`oracle.security.jps.service.credstore.Credential`	`getCredential(java.lang.String alias, java.lang.String credKey)` Deprecated.
`oracle.security.jps.service.credstore.CredentialMap`	`getCredentialMap(java.lang.String alias)` Deprecated.
`java.io.Serializable`	`getGenericCredential(java.lang.String alias, java.lang.String credKey)` Returns the Generic Credential associated with the specified alias and key.
`java.lang.String`	`getGenericCredentialDescription(java.lang.String alias, java.lang.String credKey)` Returns the Description associated with the specified alias and key.
`java.lang.String[]`	`getGenericCredentialKeys(java.lang.String alias)` Function to retrieve all the Keys in a folder(also called alias or map) which have Generic Credential associated with it.
`PortableCredential`	`getPortableCredential(java.lang.String alias, java.lang.String credKey)` Returns the `char[]` associated with the specified `alias`.
`PortableCredentialMap`	`getPortableCredentialMap(java.lang.String alias)` Returns the `Map` of `Credential` objects associated with the specified `alias`.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Returns the configured properties for this instance
`void`	`reassignGenericCredential(java.lang.String alias, java.lang.String credKey, java.io.Serializable cred, java.lang.String desc)` Reassigns the Generic Credential to the specified alias and credKey.
`void`	`refresh()` Refreshes state by reloading from backing store.
`void`	`resetCredential(java.lang.String alias, java.lang.String key, oracle.security.jps.service.credstore.Credential credential)` Deprecated.
`void`	`resetCredentialMap(java.lang.String alias, oracle.security.jps.service.credstore.CredentialMap credentialMap)` Deprecated.
`void`	`resetPortableCredential(java.lang.String alias, java.lang.String credKey, PortableCredential cred)` Assigns the `char[]` to the specified `alias` and `credKey`.
`void`	`setCredential(java.lang.String alias, java.lang.String credKey, oracle.security.jps.service.credstore.Credential cred)` Deprecated.
`void`	`setCredentialMap(java.lang.String alias, oracle.security.jps.service.credstore.CredentialMap creds)` Deprecated.
`void`	`setPortableCredential(java.lang.String alias, java.lang.String credKey, PortableCredential cred)` Assigns the `char[]` to the specified `alias` and `credKey`.
`void`	`store()` Persists this `CredentialStore` object.
`java.lang.String`	`toString()` Returns the store name as string representation of this Credential Store.

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

Method Detail

containsMap

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.containsMap",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
boolean containsMap(java.lang.String alias)
                                                                                                                                                                                                                                            throws oracle.as.jmx.framework.exceptions.ManagementException

Returns true if an map associated with the specified alias exist in this store, false otherwise.

Parameters:: alias - The name of the alias
Returns:: true if alias exists, false otherwise
Throws:: oracle.as.jmx.framework.exceptions.ManagementException - If the Credential Store has not been initialized
Since:: CSF 0.1

containsCredential

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.containsCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
boolean containsCredential(java.lang.String alias,
                                                                                                                                                                                                                                                                 java.lang.String credKey)
                                                                                                                                                                                                                                                          throws oracle.as.jmx.framework.exceptions.ManagementException

Returns true if an entry associated with the specified alias for this key exist in this store.

Parameters:: alias - The name of the alias; credKey - This credential key of this alias
Returns:: boolean Indicates whether credential exists for the information provided. True indicates availablity
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

getAliases

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.getAliases",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
java.util.Set<java.lang.String> getAliases()
                                                                                                                                                                                                                                                                  throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the Set of all the available alias.

Returns:: Set
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

deleteCredentialMap

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.deleteCredentialMap",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void deleteCredentialMap(java.lang.String alias)
                                                                                                                                                                                                                                                         throws oracle.as.jmx.framework.exceptions.ManagementException

Removes the Credential objects associated with the specified alias.

Parameters:: alias - The name of the alias
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

deleteCredential

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.deleteCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void deleteCredential(java.lang.String alias,
                                                                                                                                                                                                                                                          java.lang.String credKey)
                                                                                                                                                                                                                                                   throws oracle.as.jmx.framework.exceptions.ManagementException

Removes the Credential objects associated with the specified alias and credKey.

Parameters:: alias - The name of the alias; credKey - The key for this alias
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

deleteAllCredentials

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.deleteAllCredentials",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void deleteAllCredentials()
                                                                                                                                                                                                                                                           throws oracle.as.jmx.framework.exceptions.ManagementException

Removes all the Credential objects associated with the specified alias and credKey.

Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

store

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.store",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void store()
                                                                                                                                                                                                                             throws oracle.as.jmx.framework.exceptions.ManagementException

Persists this CredentialStore object.

Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

toString

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.toString",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
java.lang.String toString()

Returns the store name as string representation of this Credential Store.

Overrides:: toString in class java.lang.Object
Returns:: String
Since:: CSF 0.1

getProperties

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.getProperties",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns the configured properties for this instance

Returns:: The properties

getCredential

@Deprecated
 @Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.getCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
oracle.security.jps.service.credstore.Credential getCredential(java.lang.String alias,
                                                                                                                                                                                                                                                                                                             java.lang.String credKey)
                                                                                                                                                                                                                                                                                                      throws oracle.as.jmx.framework.exceptions.ManagementException

Deprecated.

Returns the Credential objects associated with the specified alias.

Parameters:: alias - The name of the alias; credKey - The credential key
Returns:: Credential
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

getCredentialMap

@Deprecated
 @Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.getCredentialMap",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
oracle.security.jps.service.credstore.CredentialMap getCredentialMap(java.lang.String alias)
                                                                                                                                                                                                                                                                                                               throws oracle.as.jmx.framework.exceptions.ManagementException

Deprecated.

Returns the Map of Credential objects associated with the specified alias.

Parameters:: alias - The name of the alias
Returns:: CredentialMap
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

setCredentialMap

@Deprecated
 @Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.setCredentialMap",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void setCredentialMap(java.lang.String alias,
                                                                                                                                                                                                                                                                       oracle.security.jps.service.credstore.CredentialMap creds)
                                                                                                                                                                                                                                                                throws oracle.as.jmx.framework.exceptions.ManagementException

Deprecated.

Assigns the Map of Credential objects to the specified specified alias.

Parameters:: alias - The alias name; creds - Map of all the credentials
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

resetCredentialMap

@Deprecated
 @Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.resetCredentialMap",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void resetCredentialMap(java.lang.String alias,
                                                                                                                                                                                                                                                                           oracle.security.jps.service.credstore.CredentialMap credentialMap)
                                                                                                                                                                                                                                                                    throws oracle.as.jmx.framework.exceptions.ManagementException

Deprecated.

Assigns the CredentialMap of Credential objects to the specified alias. If the Map already exists, it will override it.

Parameters:: alias - The alias name; credentialMap - Map of all the Credentials
Throws:: oracle.as.jmx.framework.exceptions.ManagementException - If the credential data is not valid and can not be stored If the Credential Store has not been initialized properly or this Credential cannot be set.
Since:: CSF 0.1

setCredential

@Deprecated
 @Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.setCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void setCredential(java.lang.String alias,
                                                                                                                                                                                                                                                                 java.lang.String credKey,
                                                                                                                                                                                                                                                                 oracle.security.jps.service.credstore.Credential cred)
                                                                                                                                                                                                                                                          throws oracle.as.jmx.framework.exceptions.ManagementException

Deprecated.

Assigns the Credential object to the specified alias and credKey.

Parameters:: alias - The name of the alias; credKey - The name of the credential key; cred - The credential object
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

resetCredential

@Deprecated
 @Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.resetCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void resetCredential(java.lang.String alias,
                                                                                                                                                                                                                                                                     java.lang.String key,
                                                                                                                                                                                                                                                                     oracle.security.jps.service.credstore.Credential credential)
                                                                                                                                                                                                                                                              throws oracle.as.jmx.framework.exceptions.ManagementException

Deprecated.

Reset the Credential object to the specified alias and key. If the Credential already exists, it will override it. This is a convenient method that can be used to override a specific credential.

Parameters:: alias - The name of the alias; key - The name of the Credential key; credential - The Credential object to be stored
Throws:: oracle.as.jmx.framework.exceptions.ManagementException - If the credential data is not valid and can not be stored If the Credential Store has not been initialized properly or this Credential Map cannot be set.
Since:: CSF 0.1

getPortableCredential

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.getCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
PortableCredential getPortableCredential(java.lang.String alias,
                                                                                                                                                                                                                                                                          java.lang.String credKey)
                                                                                                                                                                                                                                                                   throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the char[] associated with the specified alias.

Parameters:: alias - The name of the alias; credKey - The credential key
Returns:: PortablePasswordCredential The portable password associated with the parameters passed.
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

setPortableCredential

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.setCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void setPortableCredential(java.lang.String alias,
                                                                                                                                                                                                                                                            java.lang.String credKey,
                                                                                                                                                                                                                                                            PortableCredential cred)
                                                                                                                                                                                                                                                     throws oracle.as.jmx.framework.exceptions.ManagementException

Assigns the char[] to the specified alias and credKey.

Parameters:: alias - The name of the alias; credKey - The name of the credential key; cred - The char[] which represents the credentials object
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

resetPortableCredential

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.resetCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void resetPortableCredential(java.lang.String alias,
                                                                                                                                                                                                                                                                java.lang.String credKey,
                                                                                                                                                                                                                                                                PortableCredential cred)
                                                                                                                                                                                                                                                         throws oracle.as.jmx.framework.exceptions.ManagementException

Assigns the char[] to the specified alias and credKey.

Parameters:: alias - The name of the alias; credKey - The name of the credential key; cred - The char[] which represents the credentials object
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

getPortableCredentialMap

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.getCredentialMap",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
PortableCredentialMap getPortableCredentialMap(java.lang.String alias)
                                                                                                                                                                                                                                                                            throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the Map of Credential objects associated with the specified alias.

Parameters:: alias - The name of the alias
Returns:: PortableCredentialMap
Throws:: oracle.as.jmx.framework.exceptions.ManagementException
Since:: CSF 0.1

getGenericCredential

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getGenericCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
java.io.Serializable getGenericCredential(java.lang.String alias,
                                                                                                                                                                                                                                                                                java.lang.String credKey)
                                                                                                                                                                                                                                                                         throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the Generic Credential associated with the specified alias and key.

Parameters:: alias - The name of the alias; credKey - The credential key
Returns:: Serializable The generic credential associated with the parameters passed.
Throws:: oracle.as.jmx.framework.exceptions.ManagementException

getGenericCredentialKeys

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getGenericCredentialKeys",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
java.lang.String[] getGenericCredentialKeys(java.lang.String alias)
                                                                                                                                                                                                                                                                               throws oracle.as.jmx.framework.exceptions.ManagementException

Function to retrieve all the Keys in a folder(also called alias or map) which have Generic Credential associated with it. This is needed as the PortableCredentialMap cannot hold Generic Credentials

Parameters:: alias - Name of the Alias for which the keys are to be returned
Returns:: String[] array which contains the keys for generic credentials in the alias
Throws:: oracle.as.jmx.framework.exceptions.ManagementException

getGenericCredentialDescription

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.getGenericCredentialDescription",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=0)
java.lang.String getGenericCredentialDescription(java.lang.String alias,
                                                                                                                                                                                                                                                                                                  java.lang.String credKey)
                                                                                                                                                                                                                                                                                           throws oracle.as.jmx.framework.exceptions.ManagementException

Returns the Description associated with the specified alias and key.

Parameters:: alias - The name of the alias; credKey - The credential key
Returns:: String The description associated with the generic credential.
Throws:: oracle.as.jmx.framework.exceptions.ManagementException

reassignGenericCredential

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.reassignGenericCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void reassignGenericCredential(java.lang.String alias,
                                                                                                                                                                                                                                                                          java.lang.String credKey,
                                                                                                                                                                                                                                                                          java.io.Serializable cred,
                                                                                                                                                                                                                                                                          java.lang.String desc)
                                                                                                                                                                                                                                                                   throws oracle.as.jmx.framework.exceptions.ManagementException

Reassigns the Generic Credential to the specified alias and credKey.

Parameters:: alias - The name of the alias; credKey - The name of the credential key; cred - The Generic Credential which represents the credentials object; desc - The Description for the Credential
Throws:: oracle.as.jmx.framework.exceptions.ManagementException

assignGenericCredential

@Description(resourceKey="oracle.security.jps.management.JpsConfigurationInstanceConfigMXBean.assignGenericCredential",
             resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
 @Impact(value=1)
void assignGenericCredential(java.lang.String alias,
                                                                                                                                                                                                                                                                      java.lang.String credKey,
                                                                                                                                                                                                                                                                      java.io.Serializable cred,
                                                                                                                                                                                                                                                                      java.lang.String desc)
                                                                                                                                                                                                                                                               throws oracle.as.jmx.framework.exceptions.ManagementException

Assigns the Generic Credential to the specified alias and credKey.

Parameters:: alias - The name of the alias; credKey - The name of the credential key; cred - The Generic Credential which represents the credentials object; desc - The Description for the Credential
Throws:: oracle.as.jmx.framework.exceptions.ManagementException

refresh

@Description(resourceKey="oracle.security.jps.management.JpsCredentialStoreInstanceConfigMXBean.refresh",
             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.

Throws:: oracle.as.jmx.framework.exceptions.ManagementException

Interface JpsCredentialMXBean

Field Summary

Method Summary

Field Detail

RBN

Method Detail

containsMap

containsCredential

getAliases

deleteCredentialMap

deleteCredential

deleteAllCredentials

store

toString

getProperties

getCredential

getCredentialMap

setCredentialMap

resetCredentialMap

setCredential

resetCredential

getPortableCredential

setPortableCredential

resetPortableCredential

getPortableCredentialMap

getGenericCredential

getGenericCredentialKeys

getGenericCredentialDescription

reassignGenericCredential

assignGenericCredential

refresh