|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 1 (11.1.1) E22649-02 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CredentialMap
A CredentialMap
manages a secure mapping of keys to credentials.
The design of this class is modelled after the design of java.util.Map
. The CredentialMap
class differs from java.util.Map
in the following manner:
CredentialAccessPermission
if the instance of this map is obtained from the store by using the search API. The operations are not secured if the map instance is created using the CredentialFactory.newCredentialMap()
since this is the new copy and caller owns it.Map
Method Summary | |
---|---|
void |
clear() Deletes all the entries from the map and store. |
boolean |
containsKey(java.lang.String key) Returns true if this map contains a mapping for the specified key . |
void |
deleteCredential(java.lang.String key) Removes the Credential objects associated with the specified key . |
Credential |
getCredential(java.lang.String key) Returns the Credential object associated with the specified key . |
boolean |
isEmpty() Check if this credential map is empty. |
java.util.Set<java.lang.String> |
keySet() Returns the Set instance. |
void |
resetCredential(java.lang.String key, Credential credential) Override the Credential object to the specified key . |
void |
setCredential(java.lang.String key, Credential credential) Assigns the Credential object to the specified key . |
int |
size() Returns the number of mappings in this map. |
java.lang.String |
toString() Returns the map name as string representation of this map. |
Method Detail |
---|
java.util.Set<java.lang.String> keySet() throws CredStoreException
Set
instance. You need read CredentialAccessPermission
permission to execute this API.CredStoreException
- - If you do not have permission for this operation or there is an error.boolean isEmpty() throws CredStoreException
CredStoreException
- - If you do not have permission for this operation or there is an error.boolean containsKey(java.lang.String key) throws CredStoreException
true
if this map contains a mapping for the specified key
. You need read CredentialAccessPermission
permission to execute this API.key
- The credential key. Must be non-null and length must be greater than zero.CredStoreException
- - If you do not have permission for this operation or there is an error.int size() throws CredStoreException
CredentialAccessPermission
permission to execute this API.CredStoreException
- - If you do not have permission for this operation or there is an error.Credential getCredential(java.lang.String key) throws CredentialExpiredException, CredStoreException
Credential
object associated with the specified key
. It returns null if there is no such credential. You need read CredentialAccessPermission
permission to execute this API.key
- The credential key. Must be non-null and length must be greater than zero.CredentialExpiredException
- If this credential is already expiredCredStoreException
- - If you do not have permission for this operation or there is an error.void setCredential(java.lang.String key, Credential credential) throws CredentialAlreadyExistsException, CredentialInvalidException, CredStoreException
Credential
object to the specified key
. If this credential already exists then CredentialAlreadyExistsException
exception will be thrown. You need write CredentialAccessPermission
permission to execute this API.key
- The credential key. Must be non-null and length must be greater than zero.credential
- The credential must be non-nullCredStoreException
- - If you do not have permission for this operation or there is an error.CredentialAlreadyExistsException
- - If this credential alrady existsCredentialInvalidException
- - If the credential value is not valid and not be stored.void resetCredential(java.lang.String key, Credential credential) throws CredStoreException, CredentialInvalidException
Credential
object to the specified key
. If this credential already exists then it will be over-written. You need update CredentialAccessPermission
permission to execute this API.key
- The credential key. Must be non-null and length must be greater than zero.credential
- The credential must be non-nullCredStoreException
- - If you do not have permission for this operation or there is an error.CredentialInvalidException
- If the credential value is not valid and not be stored.void deleteCredential(java.lang.String key) throws CredentialNotFoundException, CredStoreException
Credential
objects associated with the specified key
. You need delete CredentialAccessPermission
permission to execute this API.key
- The credential key. Must be non-null and length must be greater than zero.CredStoreException
- - If you do not have permission for this operation or there is an error.CredentialNotFoundException
- - If this credential does not exist.void clear() throws CredStoreException
CredentialAccessPermission
permission to execute this API.CredStoreException
- - If you do not have permission for this operation or there is an error.java.lang.String toString()
CredentialAccessPermission
permission to execute this API.toString
in class java.lang.Object
|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 1 (11.1.1) E22649-02 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |