|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@ImmutableInfo(value="true")
@Since(value="11.1.1.0.0")
@Visibility(value=Advanced)
@SystemMBean
@MBeanRequiredGlobalSecurityRole(value=Admin)
public interface JpsCredentialMXBean
This interface defines the operations for CredentialStore management complying to JMX standards
Field Summary | |
---|---|
static java.lang.String |
RBN |
Method Summary | |
---|---|
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 . |
Credential |
getCredential(java.lang.String alias, java.lang.String credKey) Deprecated. |
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, Credential credential) Deprecated. |
void |
resetCredentialMap(java.lang.String alias, 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, Credential cred) Deprecated. |
void |
setCredentialMap(java.lang.String alias, 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 |
---|
static final java.lang.String RBN
Method Detail |
---|
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
boolean containsMap(java.lang.String alias)
throws oracle.as.jmx.framework.exceptions.ManagementException
true
if an map associated with the specified alias exist
in this store, false otherwise.alias
- The name of the aliasoracle.as.jmx.framework.exceptions.ManagementException
- If the Credential Store has not been initialized
@Description(resourceKey=<error>,
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
true
if an entry associated with the specified alias for this key exist
in this store.alias
- The name of the aliascredKey
- This credential key of this aliasoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
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
Set
of all the available alias
.oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void deleteCredentialMap(java.lang.String alias)
throws oracle.as.jmx.framework.exceptions.ManagementException
Credential
objects associated with the specified alias
.alias
- The name of the aliasoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
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
Credential
objects associated with the specified alias
and credKey
.alias
- The name of the aliascredKey
- The key for this aliasoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void deleteAllCredentials()
throws oracle.as.jmx.framework.exceptions.ManagementException
Credential
objects associated with the specified alias
and credKey
.oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void store()
throws oracle.as.jmx.framework.exceptions.ManagementException
CredentialStore
object.oracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.lang.String toString()
toString
in class java.lang.Object
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
java.util.Map<java.lang.String,java.lang.String> getProperties()
@Deprecated
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
Credential getCredential(java.lang.String alias,
java.lang.String credKey)
throws oracle.as.jmx.framework.exceptions.ManagementException
Credential
objects associated with the specified alias
.alias
- The name of the aliascredKey
- The credential keyoracle.as.jmx.framework.exceptions.ManagementException
@Deprecated
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
CredentialMap getCredentialMap(java.lang.String alias)
throws oracle.as.jmx.framework.exceptions.ManagementException
Map
of Credential
objects associated with the specified alias
.alias
- The name of the aliasoracle.as.jmx.framework.exceptions.ManagementException
@Deprecated
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void setCredentialMap(java.lang.String alias,
CredentialMap creds)
throws oracle.as.jmx.framework.exceptions.ManagementException
Map
of Credential
objects to the specified specified alias
.alias
- The alias namecreds
- Map of all the credentialsoracle.as.jmx.framework.exceptions.ManagementException
@Deprecated
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void resetCredentialMap(java.lang.String alias,
CredentialMap credentialMap)
throws oracle.as.jmx.framework.exceptions.ManagementException
CredentialMap
of Credential
objects to the specified alias
. If the Map already exists, it will override it.alias
- The alias namecredentialMap
- Map of all the Credentialsoracle.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.
@Deprecated
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void setCredential(java.lang.String alias,
java.lang.String credKey,
Credential cred)
throws oracle.as.jmx.framework.exceptions.ManagementException
Credential
object to the specified alias
and credKey
.alias
- The name of the aliascredKey
- The name of the credential keycred
- The credential objectoracle.as.jmx.framework.exceptions.ManagementException
@Deprecated
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=1)
void resetCredential(java.lang.String alias,
java.lang.String key,
Credential credential)
throws oracle.as.jmx.framework.exceptions.ManagementException
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.alias
- The name of the aliaskey
- The name of the Credential keycredential
- The Credential object to be storedoracle.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.
@Description(resourceKey=<error>,
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
char[]
associated with the specified alias
.alias
- The name of the aliascredKey
- The credential keyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
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
char[]
to the specified alias
and credKey
.alias
- The name of the aliascredKey
- The name of the credential keycred
- The char[] which represents the credentials objectoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
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
char[]
to the specified alias
and credKey
.alias
- The name of the aliascredKey
- The name of the credential keycred
- The char[] which represents the credentials objectoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
resourceBundleBasename="oracle_security_jps_mas_mgmt_util_JpsManagementMessages")
@Impact(value=0)
PortableCredentialMap getPortableCredentialMap(java.lang.String alias)
throws oracle.as.jmx.framework.exceptions.ManagementException
Map
of Credential
objects associated with the specified alias
.alias
- The name of the aliasoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
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
alias
- The name of the aliascredKey
- The credential keyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
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
alias
- Name of the Alias for which the keys are to be returnedoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
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
alias
- The name of the aliascredKey
- The credential keyoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
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
alias
- The name of the aliascredKey
- The name of the credential keycred
- The Generic Credential which represents the credentials objectdesc
- The Description for the Credentialoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
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
alias
- The name of the aliascredKey
- The name of the credential keycred
- The Generic Credential which represents the credentials objectdesc
- The Description for the Credentialoracle.as.jmx.framework.exceptions.ManagementException
@Description(resourceKey=<error>,
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
|
Oracle Fusion Middleware MBeans Java API Reference for Oracle Platform Security Services 11g Release 1 (11.1.1) E14651-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |