com.stellent.cis.client.api.sis.administrative
Interface ISISAdministrativeAPI

All Superinterfaces:

ICommandAPI

public interface ISISAdministrativeAPI
extends ICommandAPI

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

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

getFixedURL

java.lang.String getFixedURL(ISISContext SISContext)
                             throws CommandException

Provides the name of the Fixed Server location which hosts the SDK Services. This is a registry setting that is set by the Fixed Server administrator.

Parameters:

SISContext - the context object representing the current user

Throws:

CommandException

pingServer

java.lang.String pingServer(ISISContext SISContext)
                            throws CommandException

Ping the Stellent Image Server. If unable to contact the server an exception is thrown.

Parameters:

SISContext - the context object representing the current user

Throws:

CommandException

registerURL

java.lang.String registerURL(ISISContext SISContext,
                             java.lang.String urlDescription,
                             boolean removeOnUse)
                             throws CommandException

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. You must specify if the registered SOAP Ticket is to be removed after a single use. The SOAP Ticket is returned to the user as a GUID string to be used in constructing an SDK URL.

Parameters:

SISContext - the context object representing the current user

urlDescription - 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

Throws:

CommandException

registerURL

boolean registerURL(ISISContext SISContext,
                    java.lang.String ticketNumber)
                    throws CommandException

Allows the SDK user to permanently remove a SOAP Ticket from the Fixed Server. This will only need to be accessed if the strRemoveOnUse parameter for the RegisterURLDescription is set to "FALSE".

Parameters:

SISContext - the context object representing the current user

ticketNumber - The ticket number to remove.

Throws:

CommandException