Skip to main content

%Net.Remote.ObjectGateway

Class %Net.Remote.ObjectGateway Extends %Persistent [ Deprecated, StorageStrategy = ObjectGatewayStorage, System = 3 ]

This class is maintained for backward compatibility only and it is deprecated. All users should convert their use of this class to the $system.external interface as soon as possible.

Object Gateway Server definitions.

Properties​

Resource​

Property Resource As %String(MAXLEN = 64, MINLEN = 0);

The Resource name that controls access to this gateway.
If no resource is defined, then it is a public gateway which anyone can use.

Type​

Property Type As %String(DISPLAYLIST = ",Java,.NET,Python", VALUELIST = ",1,2,3") [ Required ];

Name​

Property Name As %String [ Required ];

Server​

Property Server As %String [ InitialExpression = "127.0.0.1", Required ];

Port​

Property Port As %Integer(MAXVAL = 65535, MINVAL = 1) [ Required ];

LogFile​

Property LogFile As %String(MAXLEN = 1023);

HeartbeatInterval​

Property HeartbeatInterval As %Integer(MAXVAL = 3600, MINVAL = 0) [ InitialExpression = 10 ];

HeartbeatFailureTimeout​

Property HeartbeatFailureTimeout As %Integer(MAXVAL = 86400, MINVAL = 0) [ InitialExpression = 30 ];

HeartbeatFailureAction​

Property HeartbeatFailureAction As %String(DISPLAYLIST = ",None,Restart,Alert,Restart and Alert", VALUELIST = ",N,R,A,RA") [ InitialExpression = "R" ];

HeartbeatFailureRetry​

Property HeartbeatFailureRetry As %Integer(MAXVAL = 86400, MINVAL = 0) [ InitialExpression = 300 ];

InitializationTimeout​

Property InitializationTimeout As %Integer(MAXVAL = 300, MINVAL = 2) [ InitialExpression = 5 ];

ConnectionTimeout​

Property ConnectionTimeout As %Integer(MAXVAL = 300, MINVAL = 2) [ InitialExpression = 5 ];

UsePassphrase​

Property UsePassphrase As %Boolean [ InitialExpression = 1 ];

passphraseList​

Property passphraseList As %String [ Transient ];

JavaHome​

Property JavaHome As %String(MAXLEN = 1023);

ClassPath​

Property ClassPath As %String(MAXLEN = 32000);

JVMArgs​

Property JVMArgs As %String(MAXLEN = 32000);

MainClassName​

Property MainClassName As %String [ InitialExpression = {$$$javaGatewayClass} ];

AllowedIPAddresses​

Property AllowedIPAddresses As %String [ InitialExpression = "127.0.0.1" ];

FilePath​

Property FilePath As %String(MAXLEN = 1023);

DotNetCorePath​

Property DotNetCorePath As %String(MAXLEN = 1023);

Exec32​

Property Exec32 As %Boolean [ InitialExpression = 1 ];

DotNetVersion​

Property DotNetVersion As %String(DISPLAYLIST = ",F4.6.2,F3.5,N5.0,N6.0,N7.0,N8.0", VALUELIST = ",4.6.2,3.5,Net5.0,Net6.0,Net7.0,Net8.0") [ InitialExpression = "Net6.0" ];

PythonPath​

Property PythonPath As %String(MAXLEN = 1023);

PyOptions​

Property PyOptions As %String(MAXLEN = 32000);

Methods​

ByNameExecute​

ClassMethod ByNameExecute(ByRef qHandle As %Binary, name As %String) As %Status [ Internal ]

Lookup by Gateway name.

ByNameFetch​

ClassMethod ByNameFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetAllClassesExecute ]

ByNameClose​

ClassMethod ByNameClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetAllClassesExecute ]

ByGatewayExecute​

ClassMethod ByGatewayExecute(ByRef qHandle As %Binary) As %Status [ Internal ]

Lookup all Gateways; include current state.

ByGatewayFetch​

ClassMethod ByGatewayFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ Internal, PlaceAfter = GetAllClassesExecute ]

ByGatewayClose​

ClassMethod ByGatewayClose(ByRef qHandle As %Binary) As %Status [ Internal, PlaceAfter = GetAllClassesExecute ]

GatewayState​

ClassMethod GatewayState(port As %String, interface As %String = "", server As %String = "127.0.0.1") As %Integer [ Internal ]

See method ##class(%Net.Remote.Service).IsGatewayRunning(pServer, pPort, pVerbose, .status, pPing, pInterface).

GatewayExists​

ClassMethod GatewayExists(name As %String) As %Boolean

Check if there exists a Gateway with a given name.

%DeleteData​

ClassMethod %DeleteData(id As %String, concurrency As %Integer) As %Status [ Private, ServerOnly = 1 ]

This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.

%LoadData​

Method %LoadData(id As %String) As %Status [ Private, ServerOnly = 1 ]

%LoadData() - loads an object from storage. This method is implemented by the storage class.

%SaveData​

Method %SaveData(id As %String) As %Status [ Private, ServerOnly = 1 ]

%SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.

toDao​

Method toDao() As %Library.DynamicObject

fromDao​

Method fromDao(dao As %Library.DynamicObject)

%ExistsId​

ClassMethod %ExistsId(id As %String) As %Boolean [ ServerOnly = 0 ]

Checks to see if the object identified by the ID id exists in the extent.

Returns %Boolean TRUE is it exists, FALSE if it does not.