|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface that supplies the various parameters, scope, and other aspects of a job. Also allows for reporting job results.
Method Summary | |
DirectoryObject |
allocateDirectoryObject(long entryID)
Get a DirectoryObject implementation. |
DirectoryObject |
allocateDirectoryObject(String dn,
int dnType)
Get a DirectoryObject implementation. |
CheckPrivilegesResult |
allocateDriverPrivilegesResult(int privilegeNeeded)
Allocate a CheckPrivilegesResult instance and fill in the details about what eDirectory privileges are needed
based on the "meta-privileges" passed in. |
CheckParamResult |
allocateParamResult()
Allocate a CheckParamResult implementation for use in returning a Job.checkConfig() result. |
CheckPrivilegesResult |
allocatePrivilegesResult()
Allocate a CheckPrivilegesResult implementation for use in returning a Job.checkConfig() result. |
JobResult |
allocateResult()
Get a JobResult implementation through which to report a job result. |
CheckPrivileges |
getCheckPrivileges()
Return an implementation of the CheckPrivileges interface which can be used
to check eDirectory rights. |
XmlCommandProcessor |
getCommandProcessor()
Return an XmlCommandProcessor implementation that can be
used for queries and commands to the directory. |
DriverInterface |
getDriverInterface()
Get an interface through which to interact with a DirXML driver. |
DirectoryObject |
getJobContainer()
Return information on the container object of the DirXML-Job object that defines the job. |
JobEmail |
getJobEmail()
Return an implementation of the JobEmail interface which can be used
to check email configuration and to send email. |
DirectoryObject |
getJobObject()
Return the information on the DirXML-Job object that defines the job. |
Map |
getJobParameters()
Return a Map containing the names and values of
job parameters.
|
JobScope |
getScope()
Return an interface that will return any directory objects that are in scope for this job. |
boolean |
mustAbort()
Return true if the job should abort. |
void |
reportResult(JobResult result)
Report a job result. |
Method Detail |
public boolean mustAbort()
true
if the job should abort.
true
if job should abort.public DirectoryObject getJobObject()
public Map getJobParameters()
Map
containing the names and values of
job parameters.
The following table indicates the Java types used in the Map
values
to contain the values of the job parameters:
Parameter type | Java type |
---|---|
string | java.lang.String |
boolean | java.lang.Boolean |
integer | java.lang.Integer |
real | java.lang.Double |
dn | java.lang.String |
enum | java.lang.String |
list | java.lang.String [] |
password-ref | char [] |
dn-ref | com.novell.nds.dirxml.job.DirectoryObject [] |
public XmlCommandProcessor getCommandProcessor()
XmlCommandProcessor
implementation that can be
used for queries and commands to the directory.
public JobScope getScope()
null
if no scope has been defined for the job.
null
)public JobResult allocateResult()
JobResult
implementation through which to report a job result.
public CheckParamResult allocateParamResult()
CheckParamResult
implementation for use in returning a Job.checkConfig()
result.
CheckParamResult
to be used to return the parameter error informationpublic CheckPrivilegesResult allocatePrivilegesResult()
CheckPrivilegesResult
implementation for use in returning a Job.checkConfig()
result.
CheckPrivilegesResult
to be used to return the privileges error informationpublic CheckPrivilegesResult allocateDriverPrivilegesResult(int privilegeNeeded) throws IllegalArgumentException, IllegalStateException
CheckPrivilegesResult
instance and fill in the details about what eDirectory privileges are needed
based on the "meta-privileges" passed in. This will set the target object (driver object), trustee object
(job object), and attribute name. This is a convenience method that minimizes the need for the job author to know
the details of how rights to a driver are specified.
privilegeNeeded
- one of CheckPrivileges.DRIVER_MIGRATE_APP
,
CheckPrivileges.DRIVER_SUBMIT_COMMAND
, CheckPrivileges.DRIVER_RUN
,
CheckPrivileges.DRIVER_CONFIGURE
, CheckPrivileges.DRIVER_CHECK_OBJECT_PASSWORD
, or
CheckPrivileges.DRIVER_MANAGE
.
IllegalArgumentException
- if the privilegeNeeded parameter does not specify exactly one of the
allowed values.
IllegalStateException
- if the job is not contained by a driverpublic void reportResult(JobResult result)
result
- implementation of JobResult
public DirectoryObject allocateDirectoryObject(long entryID)
DirectoryObject
implementation. This is designed for use with
the JobResult
interface.
entryID
- entry ID of directory object.
DirectoryObject
representing the directory object.
The return will be null
if no directory object has the passed entry ID.public DirectoryObject allocateDirectoryObject(String dn, int dnType) throws IllegalArgumentException
DirectoryObject
implementation. This is designed for use with
the JobResult
interface.
dn
- DN of directory objectdnType
- DirectoryObject.LDAP
, DirectoryObject.SLASH
,
DirectoryObject.QUALIFIED_SLASH
, DirectoryObject.DOT
,
DirectoryObject.QUALIFIED_DOT
DirectoryObject
representing the directory object.
The return will be null
if no directory object has the passed DN.
IllegalArgumentException
- thrown if dnType
is not one of the listed valuespublic DriverInterface getDriverInterface()
null
if the DirXML-Job object representing the calling job is
not contained by a DirXML-Driver object.
DriverInterface
implementation or null
public DirectoryObject getJobContainer()
public CheckPrivileges getCheckPrivileges()
CheckPrivileges
interface which can be used
to check eDirectory rights. Generally only used for the Job.checkConfig
method.
method.
public JobEmail getJobEmail()
JobEmail
interface which can be used
to check email configuration and to send email.
JobEmail
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |