|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISISAdministrativeAPI
The command API implementation of the administrative commands.
This implementation can be accessed directly via the ICommandFacade
class, using the API
name administrative, with the following syntax:
ISISAdministrativeAPI commandAPI = (ISISAdministrativeAPI)m_commandFacade.getCommandAPI ("administrative", m_commandFacade.getCommandTypeForName ("fixed"));
Field Summary | |
---|---|
static java.lang.String |
API_CATEGORY
Category for this Command API |
Method Summary | |
---|---|
java.lang.String |
getFixedURL(ISISContext SISContext)
Provides the name of the Fixed Server location which hosts the SDK Services. |
java.lang.String |
pingServer(ISISContext SISContext)
Ping the Stellent Image Server. |
boolean |
registerURL(ISISContext SISContext,
java.lang.String ticketNumber)
Allows the SDK user to permanently remove a SOAP Ticket from the Fixed Server. |
java.lang.String |
registerURL(ISISContext SISContext,
java.lang.String urlDescription,
boolean removeOnUse)
Allows the SDK user to register an XML string as a SOAP Ticket, which can be used in a URL call to the specified Fixed Server. |
Field Detail |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
java.lang.String getFixedURL(ISISContext SISContext) throws CommandException
SISContext
- the context object representing the current user
CommandException
java.lang.String pingServer(ISISContext SISContext) throws CommandException
SISContext
- the context object representing the current user
CommandException
java.lang.String registerURL(ISISContext SISContext, java.lang.String urlDescription, boolean removeOnUse) throws CommandException
SISContext
- the context object representing the current userurlDescription
- The XML to be registered as a SOAP Ticket.removeOnUse
- Boolean value to make the SOAP Ticket single use or multiple use. By specifying TRUE, the SOAP Ticket will be deleted once it has been used a single time. When the value is FALSE, the SOAP Ticket will remain on the Acorde Web server to be accessed until
CommandException
boolean registerURL(ISISContext SISContext, java.lang.String ticketNumber) throws CommandException
SISContext
- the context object representing the current userticketNumber
- The ticket number to remove.
CommandException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |