com.bmc.arsys.api

Class Proxy

java.lang.Object

com.bmc.arsys.apitransport.ApiProxyBase

com.bmc.arsys.api.Proxy

All Implemented Interfaces:

ApiProxyI

public class Proxy
extends ApiProxyBase

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
Proxy(boolean isLegacyServer)

Method Summary

Modifier and Type	Method and Description
void	ARCreateAssociation(ARServerUser ctx, Association object)
void	ARDeleteAssociation(ARServerUser ctx, String name, int deleteOption)
Association	ARGetAssociation(ARServerUser arServerUser, String key, AssociationCriteria criteria, Object object)
List<String>	ARGetListAssociation(ARServerUser arServerUser, String formName, long changedSince, ObjectPropertyMap propsToSearch, int enforcement, int cardinality, int type)
List<Association>	ARGetMultipleAssociations(ARServerUser arServerUser, long changedSince, List<String> names, AssociationCriteria criteria)
void	ARSetAssociation(ARServerUser arServerUser, Association object)
void	ARSetServerPort(ApiUserContextI ctx, 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	ARSetSessionConfiguration(ApiUserContextI ctx, int tag, ApiValueBase value) Allows session variables to be set.
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.
static void	IsNativeMethodAccessible()
void	setProxyProperties(ApiUserContextI context)

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

getEstablishTime, getLastUsed, getSocket, setEstablishTime, setLastUsed, setSocket

Methods inherited from class java.lang.Object

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

Constructor Detail

Proxy

public Proxy(boolean isLegacyServer)

Method Detail

IsNativeMethodAccessible

public static void IsNativeMethodAccessible()

setProxyProperties

public void setProxyProperties(ApiUserContextI context)
                        throws ARException

Specified by:

setProxyProperties in interface ApiProxyI

Overrides:

setProxyProperties in class ApiProxyBase

Throws:

ARException

ARSetServerPort

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

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

ARSetSessionConfiguration

public void ARSetSessionConfiguration(ApiUserContextI ctx,
                                      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

ARCreateAssociation

public void ARCreateAssociation(ARServerUser ctx,
                                Association object)
                         throws ARException

Throws:

ARException

ARSetAssociation

public void ARSetAssociation(ARServerUser arServerUser,
                             Association object)

ARGetAssociation

public Association ARGetAssociation(ARServerUser arServerUser,
                                    String key,
                                    AssociationCriteria criteria,
                                    Object object)

ARDeleteAssociation

public void ARDeleteAssociation(ARServerUser ctx,
                                String name,
                                int deleteOption)
                         throws ARException

Throws:

ARException

ARGetListAssociation

public List<String> ARGetListAssociation(ARServerUser arServerUser,
                                         String formName,
                                         long changedSince,
                                         ObjectPropertyMap propsToSearch,
                                         int enforcement,
                                         int cardinality,
                                         int type)

ARGetMultipleAssociations

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