public interface Admin
Modifier and Type | Interface and Description |
---|---|
static class |
Admin.AdminDescription
The description of what properties are supported by the administration
interface.
|
static class |
Admin.StringList
A list of strings, as XML.
|
static class |
Admin.URList
A list of usage records, as XML.
|
static class |
Admin.UserDesc |
static class |
Admin.UserList
A list of users, as XML.
|
Modifier and Type | Method and Description |
---|---|
Admin.StringList |
currentRuns()
The property for the list of IDs of current runs.
|
Admin.StringList |
factoryProcessMapping()
The property for the mapping of usernames to factory process handles.
|
boolean |
getAllowNew()
Get whether to allow new workflow runs to be created.
|
int |
getDefaultLifetime()
Get the default lifetime of workflow runs.
|
Admin.AdminDescription |
getDescription(javax.ws.rs.core.UriInfo ui)
Get a description of the administration interface.
|
String |
getExecuteWorkflowScript()
Get the full pathname of the executeWorkflow.sh file.
|
Admin.StringList |
getExtraArguments()
Get the extra arguments to be supplied to Java subprocesses.
|
String |
getGenerateProvenance()
Do we turn on the generate provenance option by default?
|
String |
getJavaBinary()
Get the Java binary to be used for execution of subprocesses.
|
boolean |
getLogFaults()
Get whether to log the user-directed faults.
|
boolean |
getLogWorkflows()
Get whether to log the workflows submitted.
|
int |
getOperatingLimit()
Get the maximum number of simultaneous executing runs.
|
Admin.StringList |
getPermittedWorkflowURIs()
What are the current list of workflow URIs that may be started? Empty
means allow any, including user-supplied workflows.
|
int |
getRegistrationPollMillis()
Get the interval between checks for registration of the forker process.
|
int |
getRegistrationWaitSeconds()
Get the total duration of time to wait for the start of the forker
process.
|
String |
getRegistryHost()
Get the location of the RMI registry.
|
String |
getRegistryJar()
Get the full pathname of the RMI registry's JAR.
|
int |
getRegistryPort()
Get the port of the RMI registry.
|
String |
getRunasPasswordFile()
Get the full pathname of the file containing the impersonation
credentials for the forker process.
|
int |
getRunLimit()
Get the maximum number of simultaneous runs.
|
String |
getServerForkerJar()
Get the full pathname of the forker's JAR.
|
String |
getServerWorkerJar()
Get the full pathname of the worker JAR file.
|
javax.ws.rs.core.Response |
getStaticResource(String file)
Gets support resources for the administration user interface.
|
String |
getURFile()
Get what file to dump usage records to.
|
javax.ws.rs.core.Response |
getUserInterface()
Get a simple administration user interface.
|
int |
invokeCount()
The property for the number of times the service methods have been
invoked.
|
Integer |
lastExitCode()
The property for the last exit code of the forker process.
|
int |
operatingCount()
The property for the number of runs that are currently running.
|
javax.ws.rs.core.Response |
optionsAllowNew()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsCurrentRuns()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsDefaultLifetime()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsExecuteWorkflowScript()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsExtraArguments()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsFactoryProcessMapping()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsGenerateProvenance()
Do we turn on the generate provenance option by default?
|
javax.ws.rs.core.Response |
optionsInvokationCount()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsJavaBinary()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsLastExitCode()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsLogFaults()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsLogWorkflows()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsOperatingCount()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsOperatingLimit()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsPermittedWorkflowURIs()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsRegistrationPollMillis()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsRegistrationWaitSeconds()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsRegistryHost()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsRegistryJar()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsRegistryPort()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsRoot()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsRunasPasswordFile()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsRunCount()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsRunLimit()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsServerForkerJar()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsServerWorkerJar()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsStartupTime()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsURFile()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsUsageRecords()
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsUser(String username)
What HTTP methods may we use?
|
javax.ws.rs.core.Response |
optionsUsers()
What HTTP methods may we use?
|
int |
runCount()
The property for the number of runs that are currently in existence.
|
boolean |
setAllowNew(boolean newValue)
Set whether to allow new workflow runs to be created.
|
int |
setDefaultLifetime(int defaultLifetime)
Set the default lifetime of workflow runs.
|
String |
setExecuteWorkflowScript(String executeWorkflowScript)
Set the full pathname of the executeWorkflow.sh file.
|
Admin.StringList |
setExtraArguments(Admin.StringList extraArguments)
Set the extra arguments to be supplied to Java subprocesses.
|
String |
setGenerateProvenance(String newValue)
Do we turn on the generate provenance option by default?
|
String |
setJavaBinary(String javaBinary)
Set the Java binary to be used for execution of subprocesses.
|
boolean |
setLogFaults(boolean logFaults)
Set whether to log the user-directed faults.
|
boolean |
setLogWorkflows(boolean logWorkflows)
Set whether to log the workflows submitted.
|
int |
setOperatingLimit(int operatingLimit)
Set the maximum number of simultaneous executing runs.
|
Admin.StringList |
setPermittedWorkflowURIs(Admin.StringList permitted)
What are the current list of workflow URIs that may be started? Empty
means allow any, including user-supplied workflows.
|
int |
setRegistrationPollMillis(int registrationPollMillis)
Set the interval between checks for registration of the forker process.
|
int |
setRegistrationWaitSeconds(int registrationWaitSeconds)
Set the total duration of time to wait for the start of the forker
process.
|
String |
setRegistryHost(String registryHost)
Set the location of the RMI registry.
|
String |
setRegistryJar(String registryJar)
Set the full pathname of the RMI registry's JAR.
|
int |
setRegistryPort(int registryPort)
Set the port of the RMI registry.
|
String |
setRunasPasswordFile(String runasPasswordFile)
Set the full pathname of the file containing the impersonation
credentials for the forker process.
|
int |
setRunLimit(int runLimit)
Set the maximum number of simultaneous runs.
|
String |
setServerForkerJar(String serverForkerJar)
Set the full pathname of the forker's JAR.
|
String |
setServerWorkerJar(String serverWorkerJar)
Set the full pathname of the worker JAR file.
|
String |
setURFile(String urFile)
Set what file to dump usage records to.
|
int |
startupTime()
The property for the length of time it took to start the forker.
|
Admin.URList |
usageRecords()
The property for the list of usage records collected.
|
Admin.UserDesc |
user(String username) |
javax.ws.rs.core.Response |
useradd(Admin.UserDesc userdesc,
javax.ws.rs.core.UriInfo ui) |
javax.ws.rs.core.Response |
userdel(String username) |
Admin.UserList |
users(javax.ws.rs.core.UriInfo ui) |
Admin.UserDesc |
userset(String username,
Admin.UserDesc userdesc) |
@GET @Path(value="/") @Produces(value="text/html") @Nonnull javax.ws.rs.core.Response getUserInterface() throws IOException
IOException
@GET @Path(value="static/{file}") @Produces(value="*/*") javax.ws.rs.core.Response getStaticResource(@PathParam(value="file") String file) throws IOException
file
- The name of the static resource to provide.IOException
@GET @Path(value="/") @Produces(value={"application/xml","application/json"}) @Nonnull Admin.AdminDescription getDescription(@Context javax.ws.rs.core.UriInfo ui)
ui
- What URI was used to access this resource?@OPTIONS @Path(value="/") javax.ws.rs.core.Response optionsRoot()
@GET @Path(value="allowNew") @Produces(value="text/plain") boolean getAllowNew()
@PUT @Path(value="allowNew") @Consumes(value="text/plain") @Produces(value="text/plain") boolean setAllowNew(boolean newValue)
newValue
- What to set it to.@OPTIONS @Path(value="allowNew") javax.ws.rs.core.Response optionsAllowNew()
@GET @Path(value="logWorkflows") @Produces(value="text/plain") boolean getLogWorkflows()
@PUT @Path(value="logWorkflows") @Consumes(value="text/plain") @Produces(value="text/plain") boolean setLogWorkflows(boolean logWorkflows)
logWorkflows
- What to set it to.@OPTIONS @Path(value="logWorkflows") javax.ws.rs.core.Response optionsLogWorkflows()
@GET @Path(value="logFaults") @Produces(value="text/plain") boolean getLogFaults()
@PUT @Path(value="logFaults") @Consumes(value="text/plain") @Produces(value="text/plain") boolean setLogFaults(boolean logFaults)
logFaults
- What to set it to.@OPTIONS @Path(value="logFaults") javax.ws.rs.core.Response optionsLogFaults()
@GET @Path(value="usageRecordDumpFile") @Produces(value="text/plain") @Nonnull String getURFile()
@PUT @Path(value="usageRecordDumpFile") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setURFile(@Nonnull String urFile)
urFile
- What to set it to.@OPTIONS @Path(value="usageRecordDumpFile") javax.ws.rs.core.Response optionsURFile()
@GET @Path(value="invokationCount") @Produces(value="text/plain") int invokeCount()
@OPTIONS @Path(value="invokationCount") javax.ws.rs.core.Response optionsInvokationCount()
@GET @Path(value="runCount") @Produces(value="text/plain") int runCount()
@OPTIONS @Path(value="runCount") javax.ws.rs.core.Response optionsRunCount()
@GET @Path(value="operatingCount") @Produces(value="text/plain") int operatingCount()
@OPTIONS @Path(value="operatingCount") javax.ws.rs.core.Response optionsOperatingCount()
@GET @Path(value="registryJar") @Produces(value="text/plain") @Nonnull String getRegistryJar()
@PUT @Path(value="registryJar") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setRegistryJar(@Nonnull String registryJar)
registryJar
- What to set it to.@OPTIONS @Path(value="registryJar") javax.ws.rs.core.Response optionsRegistryJar()
@GET @Path(value="registryHost") @Produces(value="text/plain") @Nonnull String getRegistryHost()
@PUT @Path(value="registryHost") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setRegistryHost(@Nonnull String registryHost)
registryHost
- What to set it to.@OPTIONS @Path(value="registryHost") javax.ws.rs.core.Response optionsRegistryHost()
@GET @Path(value="registryPort") @Produces(value="text/plain") int getRegistryPort()
@PUT @Path(value="registryPort") @Consumes(value="text/plain") @Produces(value="text/plain") int setRegistryPort(int registryPort)
registryPort
- What to set it to.@OPTIONS @Path(value="registryPort") javax.ws.rs.core.Response optionsRegistryPort()
@GET @Path(value="runLimit") @Produces(value="text/plain") int getRunLimit()
@PUT @Path(value="runLimit") @Consumes(value="text/plain") @Produces(value="text/plain") int setRunLimit(int runLimit)
runLimit
- What to set it to.@OPTIONS @Path(value="runLimit") javax.ws.rs.core.Response optionsRunLimit()
@GET @Path(value="operatingLimit") @Produces(value="text/plain") int getOperatingLimit()
@PUT @Path(value="operatingLimit") @Consumes(value="text/plain") @Produces(value="text/plain") int setOperatingLimit(int operatingLimit)
operatingLimit
- What to set it to.@OPTIONS @Path(value="operatingLimit") javax.ws.rs.core.Response optionsOperatingLimit()
@GET @Path(value="defaultLifetime") @Produces(value="text/plain") int getDefaultLifetime()
@PUT @Path(value="defaultLifetime") @Consumes(value="text/plain") @Produces(value="text/plain") int setDefaultLifetime(int defaultLifetime)
defaultLifetime
- What to set it to.@OPTIONS @Path(value="defaultLifetime") javax.ws.rs.core.Response optionsDefaultLifetime()
@GET @Path(value="currentRuns") @Produces(value={"application/xml","application/json"}) Admin.StringList currentRuns()
@OPTIONS @Path(value="currentRuns") javax.ws.rs.core.Response optionsCurrentRuns()
@GET @Path(value="javaBinary") @Produces(value="text/plain") @Nonnull String getJavaBinary()
@PUT @Path(value="javaBinary") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setJavaBinary(@Nonnull String javaBinary)
javaBinary
- What to set it to.@OPTIONS @Path(value="javaBinary") javax.ws.rs.core.Response optionsJavaBinary()
@GET @Path(value="extraArguments") @Produces(value={"application/xml","application/json"}) @Nonnull Admin.StringList getExtraArguments()
@PUT @Path(value="extraArguments") @Consumes(value="application/xml") @Produces(value={"application/xml","application/json"}) @Nonnull Admin.StringList setExtraArguments(@Nonnull Admin.StringList extraArguments)
extraArguments
- What to set it to.@OPTIONS @Path(value="extraArguments") javax.ws.rs.core.Response optionsExtraArguments()
@GET @Path(value="serverWorkerJar") @Produces(value="text/plain") @Nonnull String getServerWorkerJar()
@PUT @Path(value="serverWorkerJar") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setServerWorkerJar(@Nonnull String serverWorkerJar)
serverWorkerJar
- What to set it to.@OPTIONS @Path(value="serverWorkerJar") javax.ws.rs.core.Response optionsServerWorkerJar()
@GET @Path(value="executeWorkflowScript") @Produces(value="text/plain") @Nonnull String getExecuteWorkflowScript()
@PUT @Path(value="executeWorkflowScript") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setExecuteWorkflowScript(@Nonnull String executeWorkflowScript)
executeWorkflowScript
- What to set it to.@OPTIONS @Path(value="executeWorkflowScript") javax.ws.rs.core.Response optionsExecuteWorkflowScript()
@GET @Path(value="registrationWaitSeconds") @Produces(value="text/plain") int getRegistrationWaitSeconds()
@PUT @Path(value="registrationWaitSeconds") @Consumes(value="text/plain") @Produces(value="text/plain") int setRegistrationWaitSeconds(int registrationWaitSeconds)
registrationWaitSeconds
- What to set it to.@OPTIONS @Path(value="registrationWaitSeconds") javax.ws.rs.core.Response optionsRegistrationWaitSeconds()
@GET @Path(value="registrationPollMillis") @Produces(value="text/plain") int getRegistrationPollMillis()
@PUT @Path(value="registrationPollMillis") @Consumes(value="text/plain") @Produces(value="text/plain") int setRegistrationPollMillis(int registrationPollMillis)
registrationPollMillis
- What to set it to.@OPTIONS @Path(value="registrationPollMillis") javax.ws.rs.core.Response optionsRegistrationPollMillis()
@GET @Path(value="runasPasswordFile") @Produces(value="text/plain") @Nonnull String getRunasPasswordFile()
@PUT @Path(value="runasPasswordFile") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setRunasPasswordFile(@Nonnull String runasPasswordFile)
runasPasswordFile
- What to set it to.@OPTIONS @Path(value="runasPasswordFile") javax.ws.rs.core.Response optionsRunasPasswordFile()
@GET @Path(value="serverForkerJar") @Produces(value="text/plain") @Nonnull String getServerForkerJar()
@PUT @Path(value="serverForkerJar") @Consumes(value="text/plain") @Produces(value="text/plain") @Nonnull String setServerForkerJar(@Nonnull String serverForkerJar)
serverForkerJar
- What to set it to.@OPTIONS @Path(value="serverForkerJar") javax.ws.rs.core.Response optionsServerForkerJar()
@GET @Path(value="startupTime") @Produces(value="text/plain") int startupTime()
@OPTIONS @Path(value="startupTime") javax.ws.rs.core.Response optionsStartupTime()
@GET @Path(value="lastExitCode") @Produces(value="text/plain") Integer lastExitCode()
@OPTIONS @Path(value="lastExitCode") javax.ws.rs.core.Response optionsLastExitCode()
@GET @Path(value="factoryProcessMapping") @Produces(value={"application/xml","application/json"}) Admin.StringList factoryProcessMapping()
@OPTIONS @Path(value="factoryProcessMapping") javax.ws.rs.core.Response optionsFactoryProcessMapping()
@GET @Path(value="usageRecords") @Produces(value="application/xml") Admin.URList usageRecords()
@OPTIONS @Path(value="usageRecords") javax.ws.rs.core.Response optionsUsageRecords()
@GET @Path(value="permittedWorkflowURIs") @Produces(value={"application/xml","application/json"}) Admin.StringList getPermittedWorkflowURIs()
@GET @Path(value="generateProvenance") @Produces(value="text/plain") String getGenerateProvenance()
@PUT @Path(value="generateProvenance") @Consumes(value="text/plain") @Produces(value="text/plain") String setGenerateProvenance(String newValue)
@OPTIONS @Path(value="generateProvenance") javax.ws.rs.core.Response optionsGenerateProvenance()
@PUT @Path(value="permittedWorkflowURIs") @Consumes(value="application/xml") @Produces(value={"application/xml","application/json"}) Admin.StringList setPermittedWorkflowURIs(@Nonnull Admin.StringList permitted)
permitted
- List of URIs, encoded as strings.@OPTIONS @Path(value="permittedWorkflowURIs") javax.ws.rs.core.Response optionsPermittedWorkflowURIs()
@GET @Path(value="users") @Produces(value={"application/xml","application/json"}) Admin.UserList users(@Context javax.ws.rs.core.UriInfo ui)
@GET @Path(value="users/{id}") @Produces(value={"application/xml","application/json"}) Admin.UserDesc user(@PathParam(value="id") String username)
@POST @Path(value="users") @Consumes(value="application/xml") javax.ws.rs.core.Response useradd(Admin.UserDesc userdesc, @Nonnull @Context javax.ws.rs.core.UriInfo ui)
@PUT @Path(value="users/{id}") @Produces(value={"application/xml","application/json"}) @Consumes(value="application/xml") Admin.UserDesc userset(@PathParam(value="id") String username, Admin.UserDesc userdesc)
@DELETE @Path(value="users/{id}") @Produces(value={"application/xml","application/json"}) javax.ws.rs.core.Response userdel(@PathParam(value="id") String username)
@OPTIONS @Path(value="users") javax.ws.rs.core.Response optionsUsers()
@OPTIONS @Path(value="users/{id}") javax.ws.rs.core.Response optionsUser(@PathParam(value="id") String username)
Copyright © 2015–2018 The Apache Software Foundation. All rights reserved.