org.csapi.jr.se.pam.provisioning
Interface PAMAgentManagement

All Superinterfaces:
CsapiInterface, java.io.Serializable, Service

public interface PAMAgentManagement
extends Service

This interface represents a PAMAgentManagement.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Service
IN_SERVICE_STATE, OUT_OF_SERVICE_STATE
 
Method Summary
 void associateTypes(java.lang.String agentName, java.lang.String[] agentTypes, byte[] authToken)
          Invokes the associateTypes() method on the Parlay Gateway.
 void createAgent(java.lang.String agentName, java.lang.String[] agentTypes, byte[] authToken)
          Invokes the createAgent() method on the Parlay Gateway.
 void deleteAgent(java.lang.String agentName, byte[] authToken)
          Invokes the deleteAgent() method on the Parlay Gateway.
 void disableCapabilities(java.lang.String agentName, java.lang.String[] capabilities, byte[] authToken)
          Invokes the disableCapabilities() method on the Parlay Gateway.
 void disassociateTypes(java.lang.String agentName, java.lang.String[] agentTypes, byte[] authToken)
          Invokes the disassociateTypes() method on the Parlay Gateway.
 void enableCapabilities(java.lang.String agentName, java.lang.String[] capabilities, byte[] authToken)
          Invokes the enableCapabilities() method on the Parlay Gateway.
 org.csapi.jr.se.pam.PAMAttribute[] getAgentAttributes(java.lang.String agentName, java.lang.String agentType, java.lang.String[] attributeNames, byte[] authToken)
          Invokes the getAgentAttributes() method on the Parlay Gateway.
 boolean hasType(java.lang.String agentName, java.lang.String typeName, byte[] authToken)
          Invokes the hasType() method on the Parlay Gateway.
 boolean isAgent(java.lang.String agentName, byte[] authToken)
          Invokes the isAgent() method on the Parlay Gateway.
 boolean isCapableOf(java.lang.String agentName, java.lang.String capability, byte[] authToken)
          Invokes the isCapableOf() method on the Parlay Gateway.
 java.lang.String[] listAllCapabilities(java.lang.String agentName, byte[] authToken)
          Invokes the listAllCapabilities() method on the Parlay Gateway.
 java.lang.String[] listEnabledCapabilities(java.lang.String agentName, byte[] authToken)
          Invokes the listEnabledCapabilities() method on the Parlay Gateway.
 java.lang.String[] listTypesOfAgent(java.lang.String agentName, byte[] authToken)
          Invokes the listTypesOfAgent() method on the Parlay Gateway.
 void setAgentAttributes(java.lang.String agentName, java.lang.String agentType, org.csapi.jr.se.pam.PAMAttribute[] attributes, byte[] authToken)
          Invokes the setAgentAttributes() method on the Parlay Gateway.
 
Methods inherited from interface org.csapi.jr.se.Service
addServiceStateChangeListener, getServiceState, removeServiceStateChangeListener, setCallback
 

Method Detail

createAgent

public void createAgent(java.lang.String agentName,
                        java.lang.String[] agentTypes,
                        byte[] authToken)
                 throws PlatformException,
                        CommonException,
                        PamAgentExistsException,
                        PamUnknownTypeException,
                        PamInvalidCredentialException
Invokes the createAgent() method on the Parlay Gateway.

PlatformException
CommonException
PamAgentExistsException
PamUnknownTypeException
PamInvalidCredentialException

deleteAgent

public void deleteAgent(java.lang.String agentName,
                        byte[] authToken)
                 throws PlatformException,
                        CommonException,
                        PamUnknownAgentException,
                        PamInvalidCredentialException
Invokes the deleteAgent() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamInvalidCredentialException

isAgent

public boolean isAgent(java.lang.String agentName,
                       byte[] authToken)
                throws PlatformException,
                       CommonException,
                       PamInvalidCredentialException
Invokes the isAgent() method on the Parlay Gateway.

PlatformException
CommonException
PamInvalidCredentialException

enableCapabilities

public void enableCapabilities(java.lang.String agentName,
                               java.lang.String[] capabilities,
                               byte[] authToken)
                        throws PlatformException,
                               CommonException,
                               PamUnknownAgentException,
                               PamInvalidCredentialException
Invokes the enableCapabilities() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamInvalidCredentialException

disableCapabilities

public void disableCapabilities(java.lang.String agentName,
                                java.lang.String[] capabilities,
                                byte[] authToken)
                         throws PlatformException,
                                CommonException,
                                PamUnknownAgentException,
                                PamNoCapabilityException,
                                PamInvalidCredentialException
Invokes the disableCapabilities() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamNoCapabilityException
PamInvalidCredentialException

listEnabledCapabilities

public java.lang.String[] listEnabledCapabilities(java.lang.String agentName,
                                                  byte[] authToken)
                                           throws PlatformException,
                                                  CommonException,
                                                  PamUnknownAgentException,
                                                  PamInvalidCredentialException
Invokes the listEnabledCapabilities() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamInvalidCredentialException

listAllCapabilities

public java.lang.String[] listAllCapabilities(java.lang.String agentName,
                                              byte[] authToken)
                                       throws PlatformException,
                                              CommonException,
                                              PamUnknownAgentException,
                                              PamInvalidCredentialException
Invokes the listAllCapabilities() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamInvalidCredentialException

isCapableOf

public boolean isCapableOf(java.lang.String agentName,
                           java.lang.String capability,
                           byte[] authToken)
                    throws PlatformException,
                           CommonException,
                           PamUnknownAgentException,
                           PamInvalidCredentialException
Invokes the isCapableOf() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamInvalidCredentialException

associateTypes

public void associateTypes(java.lang.String agentName,
                           java.lang.String[] agentTypes,
                           byte[] authToken)
                    throws PlatformException,
                           CommonException,
                           PamUnknownAgentException,
                           PamUnknownTypeException,
                           PamTypeAssociatedException,
                           PamInvalidCredentialException
Invokes the associateTypes() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamUnknownTypeException
PamTypeAssociatedException
PamInvalidCredentialException

disassociateTypes

public void disassociateTypes(java.lang.String agentName,
                              java.lang.String[] agentTypes,
                              byte[] authToken)
                       throws PlatformException,
                              CommonException,
                              PamUnknownAgentException,
                              PamDisassociatedTypeException,
                              PamInvalidCredentialException
Invokes the disassociateTypes() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamDisassociatedTypeException
PamInvalidCredentialException

listTypesOfAgent

public java.lang.String[] listTypesOfAgent(java.lang.String agentName,
                                           byte[] authToken)
                                    throws PlatformException,
                                           CommonException,
                                           PamUnknownAgentException,
                                           PamInvalidCredentialException
Invokes the listTypesOfAgent() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamInvalidCredentialException

hasType

public boolean hasType(java.lang.String agentName,
                       java.lang.String typeName,
                       byte[] authToken)
                throws PlatformException,
                       CommonException,
                       PamUnknownAgentException,
                       PamInvalidCredentialException
Invokes the hasType() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamInvalidCredentialException

getAgentAttributes

public org.csapi.jr.se.pam.PAMAttribute[] getAgentAttributes(java.lang.String agentName,
                                                             java.lang.String agentType,
                                                             java.lang.String[] attributeNames,
                                                             byte[] authToken)
                                                      throws PlatformException,
                                                             CommonException,
                                                             PamUnknownAgentException,
                                                             PamUnknownTypeException,
                                                             PamUnknownAttributeException,
                                                             PamInvalidCredentialException
Invokes the getAgentAttributes() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamUnknownTypeException
PamUnknownAttributeException
PamInvalidCredentialException

setAgentAttributes

public void setAgentAttributes(java.lang.String agentName,
                               java.lang.String agentType,
                               org.csapi.jr.se.pam.PAMAttribute[] attributes,
                               byte[] authToken)
                        throws PlatformException,
                               CommonException,
                               PamUnknownAgentException,
                               PamUnknownTypeException,
                               PamUnknownAttributesException,
                               PamInvalidCredentialException
Invokes the setAgentAttributes() method on the Parlay Gateway.

PlatformException
CommonException
PamUnknownAgentException
PamUnknownTypeException
PamUnknownAttributesException
PamInvalidCredentialException