com.bmc.arsys.api

Class ProxyJRpc

java.lang.Object

com.bmc.arsys.apitransport.ApiProxyBase

com.bmc.arsys.apitransport.ApiProxyJRpcBase

com.bmc.arsys.api.ProxyJRpc

All Implemented Interfaces:

ApiProxyI

public class ProxyJRpc
extends ApiProxyJRpcBase

Proxy for Java API calls on Java RPC approach. The method placed here, overrides the one defined in Proxy.java. Those Override methods will route individual API call to Java Rpc approach by Object Oriented Polymorphism.

Field Summary

Fields inherited from interface com.bmc.arsys.apitransport.ApiProxyI

AR_JNI_RPC, AR_JRPC, CMDB_JRPC, RPC_NONE

Constructor Summary

Constructors

Constructor and Description
ProxyJRpc(ApiUserContextI context)

Method Summary

Modifier and Type	Method and Description
void	ARAddObjects(ARServerUser context, String taskName, List<com.bmc.arsys.api.ARVercntlObject> objList)
void	ARChangeIdInfo(ARServerUser context, List<ChangeIdInfo> changeInfoList, String objectModificationLogLabel, String taskName) Process ARChangeIdInfo.
void	ARCommitTask(ARServerUser context, String taskName, String desc)
void	ARCreateAssociation(ARServerUser context, Association object, String label, String taskName)
void	ARCreateCheckpoint(ARServerUser context, String taskName, String checkpointName, String desc, ObjectPropertyMap objPropList)
void	ARCreateTask(ARServerUser context, String taskName, String desc, ObjectPropertyMap objPropList, List<com.bmc.arsys.api.ARVercntlObject> objList)
void	ARDeleteAssociation(ARServerUser context, String name, int deleteOption, String objectModificationLogLabel, String taskName)
void	ARDeleteCheckpoint(ARServerUser context, String taskName, String checkpointName)
void	ARDeleteTask(ARServerUser context, String taskName)
Association	ARGetAssociation(ARServerUser context, String key, AssociationCriteria criteria, Association arg1)
List<String>	ARGetListAssociation(ARServerUser context, String name, long changedSince, ObjectPropertyMap props, int enforcement, int cardinality, int type)
List<com.bmc.arsys.api.TaskCheckpoint>	ARGetListCheckpoint(ARServerUser context, String taskName, int changedSince, List<com.bmc.arsys.api.TaskCheckpoint> cpList, com.bmc.arsys.api.TaskCheckpointCriteria criteria)
List<com.bmc.arsys.api.TaskInfo>	ARGetListTask(ARServerUser context, String owner, int changedSince, int state, List<com.bmc.arsys.api.TaskInfo> taskInfoList, com.bmc.arsys.api.TaskCriteria criteria)
List<Association>	ARGetMultipleAssociations(ARServerUser arServerUser, long changedSince, List<String> names, AssociationCriteria criteria)
void	ARGetTask(ARServerUser context, String taskName, com.bmc.arsys.api.Task task, com.bmc.arsys.api.TaskCriteria criteria)
void	ARRemoveObjects(ARServerUser context, String taskName, List<com.bmc.arsys.api.ARVercntlObject> objList)
void	ARRollbackTask(ARServerUser context, String taskName, String desc)
void	ARRollbackToCheckpoint(ARServerUser context, String taskName, String checkpointName, String desc)
void	ARSetAssociation(ARServerUser context, Association arg1, String objectModificationLogLabel, String taskName)
void	ARSetServerPort(ApiUserContextI context, int port, int progNum) Specifies the port that your program will use to communicate with the AR System server, and whether to use a private server.
void	ARSetServerPort(ARServerUser context, int port, int progNum)
void	ARSetSessionConfiguration(ApiUserContextI context, int tag, ApiValueBase value) Allows session variables to be set.
void	ARSetTask(ARServerUser context, com.bmc.arsys.api.Task task)
long	ARTermination(ApiUserContextI ctx) Performs environment-specific cleanup routines and disconnects from the specified Action Request System session.
void	ARVerifyUser(ApiUserContextI ctx) Checks the cache on the specified server to determine whether the user you specify for the control parameter is registered in AR System.

Methods inherited from class com.bmc.arsys.apitransport.ApiProxyBase

getEstablishTime, getLastUsed, getSocket, setEstablishTime, setLastUsed, setProxyProperties, setSocket

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyJRpc

public ProxyJRpc(ApiUserContextI context)
          throws ARException

Throws:

ARException

Method Detail

ARSetServerPort

public void ARSetServerPort(ApiUserContextI context,
                            int port,
                            int progNum)
                     throws ARException

Description copied from interface: ApiProxyI

Specifies the port that your program will use to communicate with the AR System server, and whether to use a private server.

Specified by:

ARSetServerPort in interface ApiProxyI

Specified by:

ARSetServerPort in class ApiProxyBase

Throws:

ARException - if port is not specified

ARSetServerPort

public void ARSetServerPort(ARServerUser context,
                            int port,
                            int progNum)
                     throws ARException

Throws:

ARException

ARSetSessionConfiguration

public void ARSetSessionConfiguration(ApiUserContextI context,
                                      int tag,
                                      ApiValueBase value)
                               throws ARException

Description copied from interface: ApiProxyI

Allows session variables to be set.

Specified by:

ARSetSessionConfiguration in interface ApiProxyI

Specified by:

ARSetSessionConfiguration in class ApiProxyBase

Throws:

ARException - if variables are not set

ARTermination

public long ARTermination(ApiUserContextI ctx)
                   throws ARException

Description copied from interface: ApiProxyI

Performs environment-specific cleanup routines and disconnects from the specified Action Request System session. All API programs that interact with AR System should call this function upon completing work in a given session. Calling this function is especially important in environments that use floating licenses. If you do not disconnect from the server, your license token is unavailable for other users for the defined time-out interval.

Specified by:

ARTermination in interface ApiProxyI

Specified by:

ARTermination in class ApiProxyBase

Throws:

ARException - if routines are not performed

ARVerifyUser

public void ARVerifyUser(ApiUserContextI ctx)
                  throws ARException

Description copied from interface: ApiProxyI

Checks the cache on the specified server to determine whether the user you specify for the control parameter is registered in AR System.

Throws:

ARException - if cache is not checked

ARCreateTask

public void ARCreateTask(ARServerUser context,
                         String taskName,
                         String desc,
                         ObjectPropertyMap objPropList,
                         List<com.bmc.arsys.api.ARVercntlObject> objList)
                  throws ARException

Throws:

ARException

ARSetTask

public void ARSetTask(ARServerUser context,
                      com.bmc.arsys.api.Task task)
               throws ARException

Throws:

ARException

ARDeleteTask

public void ARDeleteTask(ARServerUser context,
                         String taskName)
                  throws ARException

Throws:

ARException

ARCommitTask

public void ARCommitTask(ARServerUser context,
                         String taskName,
                         String desc)
                  throws ARException

Throws:

ARException

ARRollbackTask

public void ARRollbackTask(ARServerUser context,
                           String taskName,
                           String desc)
                    throws ARException

Throws:

ARException

ARCreateCheckpoint

public void ARCreateCheckpoint(ARServerUser context,
                               String taskName,
                               String checkpointName,
                               String desc,
                               ObjectPropertyMap objPropList)
                        throws ARException

Throws:

ARException

ARDeleteCheckpoint

public void ARDeleteCheckpoint(ARServerUser context,
                               String taskName,
                               String checkpointName)
                        throws ARException

Throws:

ARException

ARRollbackToCheckpoint

public void ARRollbackToCheckpoint(ARServerUser context,
                                   String taskName,
                                   String checkpointName,
                                   String desc)
                            throws ARException

Throws:

ARException

ARAddObjects

public void ARAddObjects(ARServerUser context,
                         String taskName,
                         List<com.bmc.arsys.api.ARVercntlObject> objList)
                  throws ARException

Throws:

ARException

ARRemoveObjects

public void ARRemoveObjects(ARServerUser context,
                            String taskName,
                            List<com.bmc.arsys.api.ARVercntlObject> objList)
                     throws ARException

Throws:

ARException

ARGetTask

public void ARGetTask(ARServerUser context,
                      String taskName,
                      com.bmc.arsys.api.Task task,
                      com.bmc.arsys.api.TaskCriteria criteria)
               throws ARException

Throws:

ARException

ARGetListTask

public List<com.bmc.arsys.api.TaskInfo> ARGetListTask(ARServerUser context,
                                                      String owner,
                                                      int changedSince,
                                                      int state,
                                                      List<com.bmc.arsys.api.TaskInfo> taskInfoList,
                                                      com.bmc.arsys.api.TaskCriteria criteria)
                                               throws ARException

Throws:

ARException

ARGetListCheckpoint

public List<com.bmc.arsys.api.TaskCheckpoint> ARGetListCheckpoint(ARServerUser context,
                                                                  String taskName,
                                                                  int changedSince,
                                                                  List<com.bmc.arsys.api.TaskCheckpoint> cpList,
                                                                  com.bmc.arsys.api.TaskCheckpointCriteria criteria)
                                                           throws ARException

Throws:

ARException

ARCreateAssociation

public void ARCreateAssociation(ARServerUser context,
                                Association object,
                                String label,
                                String taskName)
                         throws ARException

Throws:

ARException

ARSetAssociation

public void ARSetAssociation(ARServerUser context,
                             Association arg1,
                             String objectModificationLogLabel,
                             String taskName)
                      throws ARException

Throws:

ARException

ARGetAssociation

public Association ARGetAssociation(ARServerUser context,
                                    String key,
                                    AssociationCriteria criteria,
                                    Association arg1)
                             throws ARException

Throws:

ARException

ARDeleteAssociation

public void ARDeleteAssociation(ARServerUser context,
                                String name,
                                int deleteOption,
                                String objectModificationLogLabel,
                                String taskName)
                         throws ARException

Throws:

ARException

ARGetListAssociation

public List<String> ARGetListAssociation(ARServerUser context,
                                         String name,
                                         long changedSince,
                                         ObjectPropertyMap props,
                                         int enforcement,
                                         int cardinality,
                                         int type)
                                  throws ARException

Throws:

ARException

ARGetMultipleAssociations

public List<Association> ARGetMultipleAssociations(ARServerUser arServerUser,
                                                   long changedSince,
                                                   List<String> names,
                                                   AssociationCriteria criteria)
                                            throws ARException

Throws:

ARException

ARChangeIdInfo

public void ARChangeIdInfo(ARServerUser context,
                           List<ChangeIdInfo> changeInfoList,
                           String objectModificationLogLabel,
                           String taskName)
                    throws ARException

Process ARChangeIdInfo.

Parameters:

context -

changeInfoList -

objectModificationLogLabel -

taskName -

Throws:

ARException