org.cmis.interopserver.services.admin
Class AdminSoapBindingStub

java.lang.Object
  org.apache.axis.client.Stub
      org.cmis.interopserver.services.admin.AdminSoapBindingStub

All Implemented Interfaces:

java.rmi.Remote, javax.xml.rpc.Stub, Admin, org.cmis.interopserver.services.base.Base

public class AdminSoapBindingStub
extends org.apache.axis.client.Stub
implements Admin

Field Summary

(package private) static org.apache.axis.description.OperationDesc[]

_operations

Fields inherited from class org.apache.axis.client.Stub

_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

AdminSoapBindingStub()

AdminSoapBindingStub(javax.xml.rpc.Service service)

AdminSoapBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)

Method Summary

long	createOperator(org.cmis.interopserver.beans.CMISOperator operator) Creates the given operator.
void	deleteOperator(org.cmis.interopserver.beans.CMISOperator operator) Disables the given operator, which can not match the caller.
org.cmis.interopserver.beans.CMISOperator[]	getAllOperators() Returns list of operators in the caller's COG.
org.cmis.interopserver.beans.SimpleCOG[]	getCogs() Gets a list of valid SimpleCOGs that includes all possible COGs for a post operation such as postCAPAlert() or postIncident().
org.cmis.interopserver.beans.SimpleCOG	getMyCog() Gets the SimpleCOG of the caller
org.cmis.interopserver.beans.CMISOperator	getMyOperator() Returns the profile of the caller.
org.cmis.interopserver.beans.CMISOperator	getOperator(long operatorId) Returns the given operator for the given id.
java.lang.String[]	getValidContactTypeNames() Returns a list of valid contact types for use in editing/adding contact information for a DMIS operator.
java.lang.String	ping() This method takes no parameters and returns only "pong" indicating success.
void	saveMyOperator(org.cmis.interopserver.beans.CMISOperator operator) Saves the given operator, which must match the profile of the caller.
void	saveOperator(org.cmis.interopserver.beans.CMISOperator operator) Saves the given operator.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

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

Field Detail

_operations

static org.apache.axis.description.OperationDesc[] _operations

Constructor Detail

AdminSoapBindingStub

public AdminSoapBindingStub()
                     throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

AdminSoapBindingStub

public AdminSoapBindingStub(java.net.URL endpointURL,
                            javax.xml.rpc.Service service)
                     throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

AdminSoapBindingStub

public AdminSoapBindingStub(javax.xml.rpc.Service service)
                     throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

getCogs

public org.cmis.interopserver.beans.SimpleCOG[] getCogs()
                                                 throws java.rmi.RemoteException

Description copied from interface: org.cmis.interopserver.services.base.Base

Gets a list of valid SimpleCOGs that includes all possible COGs for a post operation such as postCAPAlert() or postIncident(). All COGs EXCEPT the operator's COG will be returned.

Specified by:

getCogs in interface org.cmis.interopserver.services.base.Base

Returns:

a list of valid SimpleCOGs

Throws:

java.rmi.RemoteException - An exception occurred remotely

getMyCog

public org.cmis.interopserver.beans.SimpleCOG getMyCog()
                                                throws java.rmi.RemoteException

Description copied from interface: org.cmis.interopserver.services.base.Base

Gets the SimpleCOG of the caller

Specified by:

getMyCog in interface org.cmis.interopserver.services.base.Base

Returns:

The SimpleCOG of the caller

Throws:

java.rmi.RemoteException - An exception occurred remotely

ping

public java.lang.String ping()
                      throws java.rmi.RemoteException

Description copied from interface: org.cmis.interopserver.services.base.Base

This method takes no parameters and returns only "pong" indicating success. It is used simply to verify that the service is up and running and user is authenticated.

Specified by:

ping in interface org.cmis.interopserver.services.base.Base

Returns:

String "pong"

Throws:

java.rmi.RemoteException - An exception occurred remotely

getValidContactTypeNames

public java.lang.String[] getValidContactTypeNames()
                                            throws java.rmi.RemoteException

Description copied from interface: Admin

Returns a list of valid contact types for use in editing/adding contact information for a DMIS operator.

Specified by:

getValidContactTypeNames in interface Admin

Returns:

A String array of valid contact types

Throws:

java.rmi.RemoteException - A remote exception occurred.

getAllOperators

public org.cmis.interopserver.beans.CMISOperator[] getAllOperators()
                                                            throws java.rmi.RemoteException

Description copied from interface: Admin

Returns list of operators in the caller's COG. Should only be called by an administrator.

Specified by:

getAllOperators in interface Admin

Returns:

A list of operators in the caller's COG.

Throws:

java.rmi.RemoteException - A remote exception occurred.

getMyOperator

public org.cmis.interopserver.beans.CMISOperator getMyOperator()
                                                        throws java.rmi.RemoteException

Description copied from interface: Admin

Returns the profile of the caller.

Specified by:

getMyOperator in interface Admin

Returns:

the profile of the caller.

Throws:

java.rmi.RemoteException - A remote exception occurred.

getOperator

public org.cmis.interopserver.beans.CMISOperator getOperator(long operatorId)
                                                      throws java.rmi.RemoteException

Description copied from interface: Admin

Returns the given operator for the given id.

Specified by:

getOperator in interface Admin

Parameters:

operatorId - id of the operator to be retrieved

Returns:

the given operator for the given id

Throws:

java.rmi.RemoteException

createOperator

public long createOperator(org.cmis.interopserver.beans.CMISOperator operator)
                    throws java.rmi.RemoteException

Description copied from interface: Admin

Creates the given operator. Should only be called by an administrator.

Specified by:

createOperator in interface Admin

Parameters:

operator - Operator profile of the DMIS operator to be created. (Default permissions)

Throws:

java.rmi.RemoteException - A remote exception occurred.

deleteOperator

public void deleteOperator(org.cmis.interopserver.beans.CMISOperator operator)
                    throws java.rmi.RemoteException

Description copied from interface: Admin

Disables the given operator, which can not match the caller. Should only be called by an administrator.

Specified by:

deleteOperator in interface Admin

Parameters:

operator - A DMIS operator to be deleted

Throws:

java.rmi.RemoteException - A remote exception occurred.

saveMyOperator

public void saveMyOperator(org.cmis.interopserver.beans.CMISOperator operator)
                    throws java.rmi.RemoteException

Description copied from interface: Admin

Saves the given operator, which must match the profile of the caller. If the current operator (the caller) is the given operator, some restrictions apply: you may not change admin rights, enable/disable your profile, or change your login.

Specified by:

saveMyOperator in interface Admin

Parameters:

operator - The DMIS operator profile of the caller

Throws:

java.rmi.RemoteException - When given operator is not the current.

saveOperator

public void saveOperator(org.cmis.interopserver.beans.CMISOperator operator)
                  throws java.rmi.RemoteException

Description copied from interface: Admin

Saves the given operator. Should only be called by an administrator. If the current operator (the caller) is the given operator, some restrictions apply: you may not change admin rights, enable/disable your profile, or change your login.

Specified by:

saveOperator in interface Admin

Parameters:

operator - A DMIS operator

Throws:

java.rmi.RemoteException - A remote exception occurred.