Skip navigation links

oracle.security.am.plugin.impl
Class UserAction

java.lang.Object
oracle.security.am.plugin.impl.UserAction

All Implemented Interfaces:

ExecutionAction, PluginAttribute

public class UserAction

extends java.lang.Object

implements ExecutionAction

UserAction Class is used to collect the credentials. The action forwards or redirects(based on the UserActionMetaData parameter) to the login page to collect more credentials .

   //create a user name context data. 
   UserContextData userNameContext =
      new UserContextData("form_username", "form_username",
                               new CredentialMetaData(PluginConstants.TEXT));
   //create a password context data
   // Any form parameter containing the words  "password", "passcode" and "_pin"  will be treated as sensitive
   // values for debug logging
   UserContextData passwordContext =
      new UserContextData("form_password", "form_password",
                               new CredentialMetaData(PluginConstants.PASSWORD));
   // create URl context data for login page                            
   UserContextData urlContext = new UserContextData(loginPageURL, new CredentialMetaData("URL")); 
        UserActionContext actionContext = new UserActionContext();

   //add the UserContextData to the CredentialActionContext
   actionContext.getContextData().add(userNameContext);
   actionContext.getContextData().add(passwordContext);
   actionContext.getContextData().add(urlContext);
       UserActionMetaData userAction = UserActionMetaData.FORWARD;
  
   // create a UserAction object and set it to the authentication context.
   UserAction action = new UserAction(actionContext, userAction);
   authContext.setAction(action);
   

Since:

OAM 11.1.1.5.2

Version:

OAM 11.1.2.0.0

Field Summary

protected static java.util.logging.Logger	LOGGER
protected static java.lang.String	OBJ_ID
protected UserActionContext	userActionContext

Fields inherited from interface oracle.security.am.plugin.PluginAttribute

KEY_TAG

Constructor Summary

UserAction()
Default constructor.

UserAction(java.lang.String credentialActionCommand, UserActionMetaData actionType)
Constructor

UserAction(java.lang.String credentialActionCommand, UserActionMetaData actionType, boolean isAffinityRequested)
Constructor

UserAction(UserActionContext userActionContext, UserActionMetaData actionType)
Constructor

UserAction(UserActionMetaData actionType)
Constructor

Method Summary

void	fromString(java.lang.String token)
ActionContext	getActionContext()
UserActionMetaData	getActionType() returns action type.
boolean	getAffinityRequested() Check affinity flag status.
oracle.security.am.plugin.PluginEventHint	getEventHint()
oracle.security.am.plugin.PluginEventFlowController	getFlowController()
java.lang.String	getKeyName()
java.lang.String	getName()
java.lang.String	getObjName()
boolean	isDisableDefaultContextParams()
void	setActionType(UserActionMetaData actionType)
void	setAffinityRequested(boolean isAffinityRequested) Set/Unset the affinity flag.
void	setDisableDefaultContextParams(boolean disableDefaultContextParams)
void	setKeyName(java.lang.String keyName)
void	setName(java.lang.String name)
java.lang.String	toStringForm()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

protected static java.util.logging.Logger LOGGER

userActionContext

protected UserActionContext userActionContext

OBJ_ID

protected static final java.lang.String OBJ_ID

See Also:

Constant Field Values

Constructor Detail

UserAction

public UserAction(java.lang.String credentialActionCommand,
                  UserActionMetaData actionType)

Constructor

Parameters:

credentialActionCommand -

actionType -

UserAction

public UserAction(UserActionContext userActionContext,
                  UserActionMetaData actionType)

Constructor

Parameters:

userActionContext -

actionType -

UserAction

public UserAction(java.lang.String credentialActionCommand,
                  UserActionMetaData actionType,
                  boolean isAffinityRequested)

Constructor

Parameters:

credentialActionCommand -

actionType -

isAffinityRequested -

UserAction

public UserAction(UserActionMetaData actionType)

Constructor

Parameters:

actionType -

UserAction

public UserAction()

Default constructor.

Method Detail

setActionType

public void setActionType(UserActionMetaData actionType)

getActionType

public UserActionMetaData getActionType()

returns action type.

Returns:

a UserActionMetaData object.

getActionContext

public ActionContext getActionContext()

Specified by:

getActionContext in interface ExecutionAction

getEventHint

public oracle.security.am.plugin.PluginEventHint getEventHint()

Specified by:

getEventHint in interface ExecutionAction

getFlowController

public oracle.security.am.plugin.PluginEventFlowController getFlowController()

Specified by:

getFlowController in interface ExecutionAction

getName

public java.lang.String getName()

Specified by:

getName in interface ExecutionAction

setName

public void setName(java.lang.String name)

Specified by:

setName in interface ExecutionAction

fromString

public void fromString(java.lang.String token)

Specified by:

fromString in interface PluginAttribute

getKeyName

public java.lang.String getKeyName()

Specified by:

getKeyName in interface PluginAttribute

getObjName

public java.lang.String getObjName()

Specified by:

getObjName in interface PluginAttribute

setKeyName

public void setKeyName(java.lang.String keyName)

Specified by:

setKeyName in interface PluginAttribute

toStringForm

public java.lang.String toStringForm()

Specified by:

toStringForm in interface PluginAttribute

isDisableDefaultContextParams

public boolean isDisableDefaultContextParams()

setDisableDefaultContextParams

public void setDisableDefaultContextParams(boolean disableDefaultContextParams)

setAffinityRequested

public void setAffinityRequested(boolean isAffinityRequested)

Description copied from interface: ExecutionAction

Set/Unset the affinity flag.

Specified by:

setAffinityRequested in interface ExecutionAction

getAffinityRequested

public boolean getAffinityRequested()

Description copied from interface: ExecutionAction

Check affinity flag status.

Specified by:

getAffinityRequested in interface ExecutionAction

Skip navigation links