|
Oracle Fusion Middleware Java API Reference for Oracle ADF Share 11g Release 2 (11.1.2.2.0) E17486-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.adf.share.security.credentialstore.spi.GenericCredentialStore
oracle.adf.share.security.providers.jps.CSFCredentialStore
public class CSFCredentialStore
Field Summary | |
---|---|
static java.lang.String |
APP_MAP_NAME |
protected static java.lang.String |
DEFAULT_JPS_LOCATION_DT |
protected ADFContext |
mADFContext |
protected oracle.security.jps.service.credstore.CredentialStore |
mCSFCredStore |
protected java.util.Map |
mEnv |
protected java.lang.String |
mJps_store |
protected java.lang.String |
mJpsConfigLocation |
protected static ADFLogger |
sLogger |
Fields inherited from class oracle.adf.share.security.credentialstore.spi.GenericCredentialStore |
---|
_applicationUser, _contextName, MAP_CREDENTIAL_SEPARATOR |
Constructor Summary | |
---|---|
CSFCredentialStore() Initialize the csf credential store using the ADF Security context environment. |
|
CSFCredentialStore(java.lang.String adfContextName) Initialize the csf credential store using the config from named ADF context |
Method Summary | |
---|---|
protected void |
checkInitCSFStore() |
Credential |
fetchCredential(java.lang.String credKey) Retrieves the credential for the specified credential key. |
Credential |
fetchCredential(java.lang.String map_name, java.lang.String adfCredKey, java.lang.String credentialKey) Fetches the credential for the given key. |
java.io.Serializable |
fetchSerializableCredential(java.lang.String credentialKey) Fetches the serializable credential for the given key. |
java.io.Serializable |
fetchSerializableCredential(java.lang.String map_name, java.lang.String adfCredKey, java.lang.String credentialKey) Internal: Applications should not use this method. Returns the serializable credential for the specified credential key. |
java.io.Serializable |
fetchSerializableCredentialForCurrentUser(java.lang.String credentialKey) Fetches the serializable credential for the given key. |
java.io.Serializable |
fetchSerializableCredentialForCurrentUser(java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credKey) Internal: Applications should not use this method. Returns the serializable credential for the specified credential key for current user. |
java.lang.String |
getJpsConfigLocation() |
protected java.lang.String |
getMapName() |
void |
initialize(java.util.Hashtable props) Internal: Applications should not use this method. Initializes the credentialstore from the properties. |
void |
initialize(java.util.Map props) |
protected static void |
logFine(java.lang.String methodName, java.lang.String msg) |
protected static void |
logFiner(java.lang.String methodName, java.lang.String msg) |
protected static void |
logFinest(java.lang.String methodName, java.lang.String msg) |
protected java.util.Map |
obtainCredentialProperties(java.lang.String adfCtxName) |
void |
removeCredential(java.lang.String credentialKey) Deletes the credential for the given credential key. |
void |
removeCredential(java.lang.String credentialKey, java.security.Principal principal) Deletes the credential for the given credential key and user principal. |
void |
removeCredential(java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credKey) Removes the credential specified credential idebtifier. |
void |
removeCredential(java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credKey, java.security.Principal principal) Internal: Applications should not use this method. Removes the credential specified by the credential key. |
protected void |
removeCredentialCSF(java.lang.String credentialKey, java.lang.String userUniqueId) Deletes the credential for the given credential key and user principal. |
protected void |
removeCredentialCSF(java.lang.String map_name, java.lang.String adfCredKey, java.lang.String credentialKey, java.lang.String userUniqueId) Deletes the credential for the given credential key and user principal. |
void |
storeCredential(Credential credential, java.lang.String credentialKey) Stores the given credential using the given credential key scoped to the current user. |
void |
storeCredential(Credential credential, java.lang.String credentialKey, java.security.Principal principal) Stores the given credential using the given credential key scoped to the given user principal. |
void |
storeCredential(Credential credential, java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credentialKey) Stores the given credential using the given credential key scoped to the current user. |
void |
storeCredential(Credential credential, java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credentialKey, java.security.Principal principal) Stores the given credential using the given credential key scoped to the given user principal. |
protected void |
storeCredentialCSF(Credential credential, java.lang.String credentialKey, java.lang.String userUniqueId) Stores the given credential using the given credential key scoped to the given user principal. |
protected void |
storeCredentialCSF(Credential credential, java.lang.String map_name, java.lang.String adfCredKey, java.lang.String credentialKey, java.lang.String userUniqueId) Stores the given credential using the given credential key scoped to the given user principal. |
void |
storeSerializableCredential(java.io.Serializable credential, java.lang.String credentialKey, java.security.Principal principal) Stores the given credential using the given credential key scoped to the given user principal. |
void |
storeSerializableCredential(java.io.Serializable cred, java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credKey, java.security.Principal principal) Internal: Applications should not use this method. Store the credential for the specified credential key and principal. |
protected void |
storeSerializableCredentialCSF(java.io.Serializable credential, java.lang.String credentialKey, java.lang.String userUniqueId) Stores the given credential using the given credential key scoped to the given user principal. |
protected void |
storeSerializableCredentialCSF(java.io.Serializable credential, java.lang.String map_name, java.lang.String adfCredKey, java.lang.String credentialKey, java.lang.String userUniqueId) Stores the given credential using the given credential key scoped to the given user principal. |
Methods inherited from class oracle.adf.share.security.credentialstore.spi.GenericCredentialStore |
---|
getApplicationUserName, getCredStoreAbsoluteLocation, getDefaultUser, getSecurityContext, getUserPrincipal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected transient java.util.Map mEnv
protected static ADFLogger sLogger
protected ADFContext mADFContext
protected java.lang.String mJps_store
protected oracle.security.jps.service.credstore.CredentialStore mCSFCredStore
public static final java.lang.String APP_MAP_NAME
protected static final java.lang.String DEFAULT_JPS_LOCATION_DT
protected java.lang.String mJpsConfigLocation
Constructor Detail |
---|
public CSFCredentialStore()
public CSFCredentialStore(java.lang.String adfContextName)
adfContextName
- ADF Context Name to obtain the concerned security environmentMethod Detail |
---|
public java.lang.String getJpsConfigLocation()
protected java.util.Map obtainCredentialProperties(java.lang.String adfCtxName)
protected void checkInitCSFStore() throws oracle.security.jps.JpsException
oracle.security.jps.JpsException
public void initialize(java.util.Map props)
public void initialize(java.util.Hashtable props)
GenericCredentialStore
initialize
in interface CredentialStorage
initialize
in class GenericCredentialStore
props
-public void storeCredential(Credential credential, java.lang.String credentialKey)
storeCredential
in interface CredentialStorage
storeCredential
in class GenericCredentialStore
credential
- Credential to be storedcredentialKey
- Key to be used for storing the credentialpublic void storeCredential(Credential credential, java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credentialKey)
storeCredential
in interface CredentialStorage2
storeCredential
in class GenericCredentialStore
credential
- Credential to be storedmapName
- ADF cred map nameadfCredKey
- ADF cred key valuecredentialKey
- Key to be used for storing the credentialpublic void storeSerializableCredential(java.io.Serializable cred, java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credKey, java.security.Principal principal)
storeSerializableCredential
in interface CredentialProvisioning2
cred
- the serializable credentialmapName
- the map nameadfCredKey
- ADF cred keycredKey
- the credential keyprincipal
- the user or role principalpublic void removeCredential(java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credKey, java.security.Principal principal) throws CredentialNotFoundException
removeCredential
in interface CredentialProvisioning2
credKey
- the credential keymapName
- the map nameadfCredKey
- ADF cred keyprincipal
- the user or role principaloracle.security.jps.service.credstore.CredentialNotFoundException
- if the credential does not exist for the given keyCredentialNotFoundException
public Credential fetchCredential(java.lang.String map_name, java.lang.String adfCredKey, java.lang.String credentialKey) throws CredentialNotFoundException
fetchCredential
in interface CredentialStorage2
fetchCredential
in class GenericCredentialStore
credentialKey
- Key for which the credential needs to be fetchedmap_name
- the map nameadfCredKey
- ADF cred keyoracle.security.jps.service.credstore.CredentialNotFoundException
- if the credential does not existCredentialNotFoundException
public Credential fetchCredential(java.lang.String credKey) throws CredentialNotFoundException
fetchCredential
in interface CredentialStorage
fetchCredential
in class GenericCredentialStore
mapName
- the map nameadfCredKey
- ADF cred keycredKey
- the credential keynull
if not foundoracle.security.jps.service.credstore.CredentialNotFoundException
- if the credential for the given key cannot be foundCredentialNotFoundException
public java.io.Serializable fetchSerializableCredentialForCurrentUser(java.lang.String credentialKey) throws CredentialNotFoundException
fetchSerializableCredentialForCurrentUser
in interface CredentialStorage
fetchSerializableCredentialForCurrentUser
in class GenericCredentialStore
credentialKey
- Key to be used to fetch the credentialoracle.security.jps.service.credstore.CredentialNotFoundException
- if the credential for the given key cannot be found TODO: Check should we just throw exception incase current user principal is not available? Otherwise there's no difference between this and fetchSerializableCredential api.CredentialNotFoundException
public java.io.Serializable fetchSerializableCredentialForCurrentUser(java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credKey) throws CredentialNotFoundException
fetchSerializableCredentialForCurrentUser
in interface CredentialStorage2
fetchSerializableCredentialForCurrentUser
in class GenericCredentialStore
mapName
- the map nameadfCredKey
- ADF cred keycredKey
- the credential keynull
if not foundoracle.security.jps.service.credstore.CredentialNotFoundException
- if the credential for the given key cannot be foundCredentialNotFoundException
public java.io.Serializable fetchSerializableCredential(java.lang.String map_name, java.lang.String adfCredKey, java.lang.String credentialKey) throws CredentialNotFoundException
fetchSerializableCredential
in interface CredentialStorage2
fetchSerializableCredential
in class GenericCredentialStore
map_name
- the map nameadfCredKey
- ADF cred keycredentialKey
- the credential keynull
if not foundoracle.security.jps.service.credstore.CredentialNotFoundException
- if the credential for the given key cannot be foundCredentialNotFoundException
public java.io.Serializable fetchSerializableCredential(java.lang.String credentialKey) throws CredentialNotFoundException
fetchSerializableCredential
in interface CredentialStorage
fetchSerializableCredential
in class GenericCredentialStore
credentialKey
- Key to be used to fetch the credentialoracle.security.jps.service.credstore.CredentialNotFoundException
- if the credential for the given key cannot be foundCredentialNotFoundException
public void removeCredential(java.lang.String credentialKey) throws CredentialNotFoundException
removeCredential
in interface CredentialStorage
removeCredential
in class GenericCredentialStore
credentialKey
- Key for the credential to be deleted.oracle.security.jps.service.credstore.CredentialNotFoundException
- if the credential for the given key cannot be foundCredentialNotFoundException
public void storeCredential(Credential credential, java.lang.String credentialKey, java.security.Principal principal)
storeCredential
in interface CredentialProvisioning
credential
- Credential to be storedcredentialKey
- Key to be used for storing the credentialprincipal
- User Principal to store the credential againstpublic void storeCredential(Credential credential, java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credentialKey, java.security.Principal principal)
storeCredential
in interface CredentialProvisioning2
credential
- Credential to be storedmapName
- ADF map name for credadfCredKey
- ADF cred key valuecredentialKey
- Key to be used for storing the credentialprincipal
- User Principal to store the credential againstprotected void storeCredentialCSF(Credential credential, java.lang.String credentialKey, java.lang.String userUniqueId)
credential
- Credential to be storedcredentialKey
- Key to be used for storing the credentialuserUniqueId
- User's unique id to store the credential againstprotected void storeCredentialCSF(Credential credential, java.lang.String map_name, java.lang.String adfCredKey, java.lang.String credentialKey, java.lang.String userUniqueId)
credential
- Credential to be storedmap_name
- ADF map name valueadfCredKey
- ADF cred key valuecredentialKey
- Key to be used for storing the credentialuserUniqueId
- User's unique id to store the credential againstpublic void storeSerializableCredential(java.io.Serializable credential, java.lang.String credentialKey, java.security.Principal principal)
storeSerializableCredential
in interface CredentialProvisioning
credential
- Serializable Credential to be storedcredentialKey
- Key to be used for storing the credentialprincipal
- User Principal to store the credential againstprotected void storeSerializableCredentialCSF(java.io.Serializable credential, java.lang.String credentialKey, java.lang.String userUniqueId)
credential
- Serializable Credential to be storedcredentialKey
- Key to be used for storing the credentialuserUniqueId
- User's unique id to store the credential againstprotected void storeSerializableCredentialCSF(java.io.Serializable credential, java.lang.String map_name, java.lang.String adfCredKey, java.lang.String credentialKey, java.lang.String userUniqueId)
credential
- Serializable Credential to be storedcredentialKey
- Key to be used for storing the credentialuserUniqueId
- User's unique id to store the credential againstpublic void removeCredential(java.lang.String credentialKey, java.security.Principal principal) throws CredentialNotFoundException
removeCredential
in interface CredentialProvisioning
credentialKey
- key for the credential to be deletedprincipal
- User Principal for which the credential needs to be deleted.CredentialNotFoundException
- if the credential does not exist for the given keypublic void removeCredential(java.lang.String mapName, java.lang.String adfCredKey, java.lang.String credKey) throws CredentialNotFoundException
removeCredential
in interface CredentialStorage2
removeCredential
in class GenericCredentialStore
mapName
- the map nameadfCredKey
- ADF cred keycredKey
- the credential keyoracle.security.jps.service.credstore.CredentialNotFoundException
- if the credential for the given key cannot be foundCredentialNotFoundException
protected void removeCredentialCSF(java.lang.String credentialKey, java.lang.String userUniqueId) throws CredentialNotFoundException
credentialKey
- key for the credential to be deleteduserUniqueId
- User's unique id for which the credential needs to be deleted.CredentialNotFoundException
protected void removeCredentialCSF(java.lang.String map_name, java.lang.String adfCredKey, java.lang.String credentialKey, java.lang.String userUniqueId) throws CredentialNotFoundException
map_name
- ADF cred map name valueadfCredKey
- ADF cred key valuecredentialKey
- key for the credential to be deleteduserUniqueId
- User's unique id for which the credential needs to be deleted.CredentialNotFoundException
protected java.lang.String getMapName()
protected static void logFine(java.lang.String methodName, java.lang.String msg)
protected static void logFiner(java.lang.String methodName, java.lang.String msg)
protected static void logFinest(java.lang.String methodName, java.lang.String msg)
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Share 11g Release 2 (11.1.2.2.0) E17486-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |