oracle.fmwplatform.actionframework.api.v2

Interface ActionFactory

public interface ActionFactory

ActionFactory is the API the consumer will use to retrieve an Action for the custom or standard action name.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_ACTION_PROPERTY System property to designate plugins that are not in an oracle home location.

Method Summary

Modifier and Type	Method and Description
boolean	addActionSearchPath(File actionSearchPath) Add a custom jar to the action search path.
Action	getAction(String actionName) Return the action associated with the provided action name.
Action	getAction(String actionName, ActionType actionType) Return the action associated with the action name using the provided oracle home as a search location.
Action	getAction(String actionName, String oracleHome) Return the action associated with the action name using the provided oracle home as a search location.
Action	getAction(String actionName, String oracleHome, ActionType actionType) Return the action associated with the action name using the provided oracle home as a search location.
Class<? extends Action>	getClassForName(String className, String oracleHome) Return the class object for a standard action class.
List<ActionName>	getKnownActions() Return the names of all known actions.
LifecycleOperation	getLifecycleOperation(String operationName) Return the lifecycle operation associated with the supplied name.

Field Detail

CUSTOM_ACTION_PROPERTY

static final String CUSTOM_ACTION_PROPERTY

System property to designate plugins that are not in an oracle home location.

See Also:

Constant Field Values

Method Detail

getAction

Action getAction(String actionName)
          throws ActionException

Return the action associated with the provided action name.

Parameters:

actionName - standard or custom action name

Returns:

Action or null if the action was not located

Throws:

ActionException - an unexpected error occurred attempting to search for or instantiate the action

getAction

Action getAction(String actionName,
                 ActionType actionType)
          throws ActionException

Return the action associated with the action name using the provided oracle home as a search location.

Parameters:

actionName - standard or custom action name

actionType - the type of the action to be loaded

Returns:

Action or null if the action was not located

Throws:

ActionException - an unexpected error occurred attempting to search for or instantiate the action

getAction

Action getAction(String actionName,
                 String oracleHome)
          throws ActionException

Return the action associated with the action name using the provided oracle home as a search location.

Parameters:

actionName - standard or custom action name

oracleHome - location to search for the action

Returns:

Action or null if the action was not located

Throws:

ActionException - an unexpected error occurred attempting to search for or instantiate the action

getAction

Action getAction(String actionName,
                 String oracleHome,
                 ActionType actionType)
          throws ActionException

Return the action associated with the action name using the provided oracle home as a search location.

Parameters:

actionName - standard or custom action name

oracleHome - location to search for the action

actionType - the type of the action to be loaded

Returns:

Action or null if the action was not located

Throws:

ActionException - an unexpected error occurred attempting to search for or instantiate the action

getLifecycleOperation

LifecycleOperation getLifecycleOperation(String operationName)
                                  throws ActionException

Return the lifecycle operation associated with the supplied name.

Parameters:

operationName - name of the lifecycle operation

Returns:

lifecycle operation object

Throws:

ActionException - if an error occurs or lifecycle is not found

getClassForName

Class<? extends Action> getClassForName(String className,
                                        String oracleHome)
                                 throws ActionException

Return the class object for a standard action class.

Parameters:

className - name of the action class

oracleHome - Oracle home containing the requested action, null for default home

Returns:

the Class object for the requested class name

Throws:

ActionException - an unexpected error occurred attempting to load the action class

getKnownActions

List<ActionName> getKnownActions()

Return the names of all known actions. Note that this list may change as additional action search locations are added by loading actions from different Oracle Homes.

Returns:

list of known action names and the Oracle Homes they reside in.

addActionSearchPath

boolean addActionSearchPath(File actionSearchPath)

Add a custom jar to the action search path. Note that this method must be called prior to the first getAction() call with this ActionFactory. If the File object passed does not exist, nothing will be added to the action search path. If the File object passed represents a directory then the directory will be added to the search path.

Parameters:

actionSearchPath - the directory (or file) that should be added to the search path

Returns:

true if the directory was added, false if action loading has already occurred and additional search paths cannot be added or the file passed does not exist