Home > Class Reference > ENSLIB namespace > EnsLib.Agent.Interface


persistent class EnsLib.Agent.Interface extends %Library.Persistent, %XML.Adaptor

SQL Table Name: EnsLib_Agent.Interface

instances of this class represent configuration linkages : entries in a table of client interfaces

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter FDOptions = FD_CreateDir=0,FD_UseTemp=*;
File_Drop options
parameter FPOptions = FP_DeleteWhenDone=1,FP_CreateDir=0,FP_DirPollingInterval=20,FP_ConfirmSizeInterval=0,FP_MinutesRecent=0,FP_Wildcard=*;
File_Pick options
parameter SAOptions = SA_PollInterval=12,SA_StayConnected=20;
General Agent options
parameter TCOptions = TC_IdleDisconnect=0,TC_ConnectTimeout=20,TC_ReadTimeout=10,TC_CallInterval=2;
TCP_Connect options
parameter TLOptions = TL_MaxSockets=4,TL_IdleDisconnect=0,TL_ReadTimeout=10,TL_CallInterval=2;
TCP_Listen options

Properties (Including Private)

property AgentName as %String (MAXLEN = 128) [ Required ];
Name of the Agent this interface communicates with
Property methods: AgentNameDisplayToLogical(), AgentNameGet(), AgentNameGetStored(), AgentNameIsValid(), AgentNameLogicalToDisplay(), AgentNameLogicalToOdbc(), AgentNameNormalize(), AgentNameSet()
property Availability as %String (VALUELIST = ",Init,Ready,Failed,Stopped,Partial,PartialFailed,PartialStopped,Overdue", XMLPROJECTION = "None") [ InitialExpression = "Init" ];
Availability of Interface or of Agent as a whole (when ClientId=0). 'Partial...' and 'Overdue' values apply only to Agent root interface records.
Property methods: AvailabilityDisplayToLogical(), AvailabilityGet(), AvailabilityGetStored(), AvailabilityIsValid(), AvailabilityLogicalToDisplay(), AvailabilityLogicalToOdbc(), AvailabilityNormalize(), AvailabilitySet()
property ClientId as %Integer [ Required ];
Number of the client interface for a given Agent. Interface 0 is for the agent itself
Property methods: ClientIdDisplayToLogical(), ClientIdGet(), ClientIdGetStored(), ClientIdIsValid(), ClientIdLogicalToDisplay(), ClientIdNormalize(), ClientIdSet(), ClientIdXSDToLogical()
property ConfigItem as %String (MAXLEN = 128);
Associated config item for settings: if any then affinity with the named configured Agent.ProxyService; if empty the first Agent.ProxyService found will be used.
Property methods: ConfigItemDisplayToLogical(), ConfigItemGet(), ConfigItemGetStored(), ConfigItemIsValid(), ConfigItemLogicalToDisplay(), ConfigItemLogicalToOdbc(), ConfigItemNormalize(), ConfigItemSet()
property ConfigTimeout as %Numeric [ InitialExpression = 30 ];
Number of seconds the associated config item should wait for a synchronous confirmation from the Agent of outbound traffic on this interface
Property methods: ConfigTimeoutDisplayToLogical(), ConfigTimeoutGet(), ConfigTimeoutGetStored(), ConfigTimeoutIsValid(), ConfigTimeoutLogicalToDisplay(), ConfigTimeoutNormalize(), ConfigTimeoutSet(), ConfigTimeoutXSDToLogical()
property Credential as %String);
Authentication for the client
Property methods: CredentialDisplayToLogical(), CredentialGet(), CredentialGetStored(), CredentialIsValid(), CredentialLogicalToDisplay(), CredentialLogicalToOdbc(), CredentialNormalize(), CredentialSet()
property Description as %String);
Descriptive name of the interface
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Location as %String);
File path or TCP Address/Port for the interface
Property methods: LocationDisplayToLogical(), LocationGet(), LocationGetStored(), LocationIsValid(), LocationLogicalToDisplay(), LocationLogicalToOdbc(), LocationNormalize(), LocationSet()
property Notes as %String);
Notes about the interface
Property methods: NotesDisplayToLogical(), NotesGet(), NotesGetStored(), NotesIsValid(), NotesLogicalToDisplay(), NotesLogicalToOdbc(), NotesNormalize(), NotesSet()
property Options as array of %String;
Options for the interface to be sent to the remote agent; some may be derived from the ConfigItem
Property methods: OptionsBuildValueArray(), OptionsCollectionToDisplay(), OptionsCollectionToOdbc(), OptionsDisplayToCollection(), OptionsDisplayToLogical(), OptionsGet(), OptionsGetObject(), OptionsGetObjectId(), OptionsGetStored(), OptionsGetSwizzled(), OptionsIsValid(), OptionsLogicalToDisplay(), OptionsLogicalToOdbc(), OptionsNormalize(), OptionsOdbcToCollection(), OptionsSet(), OptionsSetObject(), OptionsSetObjectId()
property RelayPort as %Integer;
Local port to use in relaying TCP traffic to the Agent.ProxyService
Property methods: RelayPortDisplayToLogical(), RelayPortGet(), RelayPortGetStored(), RelayPortIsValid(), RelayPortLogicalToDisplay(), RelayPortNormalize(), RelayPortSet(), RelayPortXSDToLogical()
property Type as %String (MAXLEN = 11, VALUELIST = ",Agent,File_Drop,File_Pick,TCP_Connect,TCP_Listen");
Type of interface on the agent; if empty then the interface is for the agent itself and the ClientId is 0
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()

Methods (Including Private)

private method %OnAddToSaveSet(depth As %Integer = 3, insert As %Integer = 0, callcount As %Integer = 0) as %Status
Inherited description: This callback method is invoked when the current object is added to the SaveSet, either because %Save() was invoked on this object or on an object that references this object. %OnAddToSaveSet can modify the current object. It can also add other objects to the current SaveSet by invoking %AddToSaveSet or remove objects by calling %RemoveFromSaveSet.

If this method returns an error status then %Save() will fail and the transaction will be rolled back.

private method %OnNew(pAgent) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method AddStatus(pCode, pText)
Construct a new StatusEvent entry for the current Interface
classmethod DeleteAgent(pAgentName As %String) as %Status
classmethod GetAgentService(pAgentName As