oracle.as.scheduler.cp
Class SubmissionUtil

java.lang.Object
  oracle.as.scheduler.cp.SubmissionUtil

public class SubmissionUtil
extends java.lang.Object

Submission Utility. This class provides helper methods to use before request submission.

Field Summary

static java.lang.String	ARGUMENT_PREFIX
static java.lang.String	PP_ACTION_PREFIX
static java.lang.String	PP_ARGUMENT_NAME
static java.lang.String	PP_PREFIX

Constructor Summary

SubmissionUtil()

Method Summary

static void	addPPAction(RequestParameters params, int actionOrder, java.lang.String actionName, boolean onSuccess, boolean onWarning, boolean onError, java.lang.String fileMgmtGroup, java.lang.String[] arguments) Deprecated. Use addPPAction(RequestParameters, int, String, String, boolean, boolean, boolean, String, String[])
static void	addPPAction(RequestParameters params, int actionOrder, java.lang.String actionName, boolean onSuccess, boolean onWarning, boolean onError, java.lang.String fileMgmtGroup, java.lang.String stepPath, java.lang.String[] arguments) Deprecated. Use addPPAction(RequestParameters, int, String, String, boolean, boolean, boolean, String, String, String[])
static void	addPPAction(RequestParameters params, int actionOrder, java.lang.String actionName, java.lang.String description, boolean onSuccess, boolean onWarning, boolean onError, java.lang.String fileMgmtGroup, java.lang.String[] arguments) Adds a post-processing action to a request.
static void	addPPAction(RequestParameters params, int actionOrder, java.lang.String actionName, java.lang.String description, boolean onSuccess, boolean onWarning, boolean onError, java.lang.String fileMgmtGroup, java.lang.String stepPath, java.lang.String[] arguments) Adds a post-processing action to a step in a jobset request.
static java.lang.String	getFilePersistenceMode()
static java.net.URL	getNotificationServiceURL()
static java.lang.String	getRequestFileDirectory()
static java.net.URI	getSAMLTokenPolicyURI()
static void	setNLSOptions(RequestParameters params, java.lang.String language, java.lang.String territory, java.lang.String numericCharacters) Sets NLS environment options for a request.
static void	setNLSOptions(RequestParameters params, java.lang.String stepPath, java.lang.String language, java.lang.String territory, java.lang.String numericCharacters) Sets NLS environment options for a step within a jobset request.
static void	setStepArgs(RequestParameters params, java.lang.String stepPath, java.lang.String[] arguments) Marshals arguments in the existing CP style into an ESS properties for a step in a jobset request.
static void	setSubmitArgs(RequestParameters params, java.lang.String[] arguments) Marshals arguments in the existing CP style into ESS properties.

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENT_PREFIX

public static final java.lang.String ARGUMENT_PREFIX

See Also:

Constant Field Values

PP_ACTION_PREFIX

public static final java.lang.String PP_ACTION_PREFIX

See Also:

Constant Field Values

PP_PREFIX

public static final java.lang.String PP_PREFIX

See Also:

Constant Field Values

PP_ARGUMENT_NAME

public static final java.lang.String PP_ARGUMENT_NAME

See Also:

Constant Field Values

Constructor Detail

SubmissionUtil

public SubmissionUtil()

Method Detail

setSubmitArgs

public static void setSubmitArgs(RequestParameters params,
                                 java.lang.String[] arguments)
                          throws IllegalArgumentException

Marshals arguments in the existing CP style into ESS properties. It would be invoked prior to submitting the request. The key of each argument is ARGUMENT_PREFIX#, where # is the ordinal value of the argument. For example ARGUMENT_PREFIX1="firstArg" and ARGUMENT_PREFIX2="secondArg".

Parameters:

params - a RequestParameters object into which this method adds parameters.

arguments - arguments for concurrent request

Throws:

IllegalArgumentException - if the number of arguments exceeds 100

setStepArgs

public static void setStepArgs(RequestParameters params,
                               java.lang.String stepPath,
                               java.lang.String[] arguments)
                        throws IllegalArgumentException

Marshals arguments in the existing CP style into an ESS properties for a step in a jobset request. It would be invoked prior to submitting the request.

Parameters:

params - a RequestParameters object into which this method adds parameters.

stepPath - the pathname of a step in a jobset

arguments - Argument for concurrent request

Throws:

IllegalArgumentException - if the number of arguments exceeds 100

setNLSOptions

public static void setNLSOptions(RequestParameters params,
                                 java.lang.String language,
                                 java.lang.String territory,
                                 java.lang.String numericCharacters)

Sets NLS environment options for a request.

Parameters:

params - a RequestParameters object into which this method adds parameters.

language -

territory -

numericCharacters -

setNLSOptions

public static void setNLSOptions(RequestParameters params,
                                 java.lang.String stepPath,
                                 java.lang.String language,
                                 java.lang.String territory,
                                 java.lang.String numericCharacters)

Sets NLS environment options for a step within a jobset request.

Parameters:

params - a RequestParameters object into which this method adds parameters.

stepPath - a pathname of a step in a jobset

language -

territory -

numericCharacters -

addPPAction

public static void addPPAction(RequestParameters params,
                               int actionOrder,
                               java.lang.String actionName,
                               java.lang.String description,
                               boolean onSuccess,
                               boolean onWarning,
                               boolean onError,
                               java.lang.String fileMgmtGroup,
                               java.lang.String[] arguments)
                        throws IllegalArgumentException

Adds a post-processing action to a request. This method is called prior to submitting the request. It provides support for action previously supported by add_printer, add_notification, add_layout in CP. The parameters to these legacy routines are passed as arguments to addPPAction in the order in which they were declared in the original routine.

Parameters:

params - a RequestParameters object into which this method adds parameters.

actionOrder - The ordinal location of this action in the sequence of actions to be performed within the action domain. If a previous action used the same actionOrder, then this action will replace the previous action.

actionName - The name of the action to perform. For example, 'PRINT', 'NOTIFY', 'LAYOUT'.

onSuccess - Determines whether this action should be performed on successful completion of the job.

onWarning - Determines whether this action should be performed when the job or step has completed with a warning.

onError - Determines whether this action should be performed when the job or step has completed with an error.

fileMgmtGroup - Name of the File Management Group

description - Description of this post processor action

arguments - A list of arguments for the post processor action.

Throws:

IllegalArgumentException - if the number of arguments exceeds 10

addPPAction

@Deprecated
public static void addPPAction(RequestParameters params,
                                          int actionOrder,
                                          java.lang.String actionName,
                                          boolean onSuccess,
                                          boolean onWarning,
                                          boolean onError,
                                          java.lang.String fileMgmtGroup,
                                          java.lang.String[] arguments)
                        throws IllegalArgumentException

Deprecated. Use addPPAction(RequestParameters, int, String, String, boolean, boolean, boolean, String, String[])

Throws:

IllegalArgumentException

addPPAction

public static void addPPAction(RequestParameters params,
                               int actionOrder,
                               java.lang.String actionName,
                               java.lang.String description,
                               boolean onSuccess,
                               boolean onWarning,
                               boolean onError,
                               java.lang.String fileMgmtGroup,
                               java.lang.String stepPath,
                               java.lang.String[] arguments)
                        throws IllegalArgumentException

Adds a post-processing action to a step in a jobset request. This method is called prior to submitting the request. It provides support for action previously supported by add_printer, add_notification, add_layout in CP. The parameters to these legacy routines are passed as arguments to addPPAction in the order in which they were declared in the original routine.

Parameters:

params - a RequestParameters object into which this method adds parameters.

actionOrder - The ordinal location of this action in the sequence of actions to be performed within the action domain. If a previous action used the same actionOrder, then this action will replace the previous action;

actionName - The name of the action to perform. For example, 'PRINT', 'NOTIFY', 'LAYOUT'.

onSuccess - Determines whether this action should be performed on successful completion of the job.

onWarning - Determines whether this action should be performed when the job or step has completed with a warning.

onError - Determines whether this action should be performed when the job or step has completed with an error.

fileMgmtGroup - Name of the File Management Group

description - Description of this post processor action

stepPath - the path to the step in the jobset;

arguments - A list of arguments for the post processor action.

Throws:

IllegalArgumentException - if the number of arguments exceeds 10

addPPAction

@Deprecated
public static void addPPAction(RequestParameters params,
                                          int actionOrder,
                                          java.lang.String actionName,
                                          boolean onSuccess,
                                          boolean onWarning,
                                          boolean onError,
                                          java.lang.String fileMgmtGroup,
                                          java.lang.String stepPath,
                                          java.lang.String[] arguments)
                        throws IllegalArgumentException

Deprecated. Use addPPAction(RequestParameters, int, String, String, boolean, boolean, boolean, String, String, String[])

Throws:

IllegalArgumentException

getNotificationServiceURL

public static final java.net.URL getNotificationServiceURL()
                                                    throws java.lang.Exception,
                                                           java.net.MalformedURLException

Throws:

java.lang.Exception

java.net.MalformedURLException

getSAMLTokenPolicyURI

public static final java.net.URI getSAMLTokenPolicyURI()
                                                throws java.lang.Exception,
                                                       java.net.URISyntaxException

Throws:

java.lang.Exception

java.net.URISyntaxException

getRequestFileDirectory

public static final java.lang.String getRequestFileDirectory()
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getFilePersistenceMode

public static final java.lang.String getFilePersistenceMode()
                                                     throws java.lang.Exception

Throws:

java.lang.Exception