%Net.Remote.ObjectGateway

deprecated persistent class %Net.Remote.ObjectGateway extends %Library.Persistent

SQL Table Name: %Net_Remote.ObjectGateway

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.

Property Inventory

Properties

property AllowedIPAddresses as %String [ InitialExpression = "127.0.0.1" ];

Property methods: AllowedIPAddressesDisplayToLogical(), AllowedIPAddressesGet(), AllowedIPAddressesIsValid(), AllowedIPAddressesLogicalToDisplay(), AllowedIPAddressesLogicalToOdbc(), AllowedIPAddressesNormalize(), AllowedIPAddressesSet()

property ClassPath as %String (MAXLEN = 32000);

Property methods: ClassPathDisplayToLogical(), ClassPathGet(), ClassPathIsValid(), ClassPathLogicalToDisplay(), ClassPathLogicalToOdbc(), ClassPathNormalize(), ClassPathSet()

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

Property methods: ConnectionTimeoutDisplayToLogical(), ConnectionTimeoutGet(), ConnectionTimeoutIsValid(), ConnectionTimeoutLogicalToDisplay(), ConnectionTimeoutNormalize(), ConnectionTimeoutSet()

property DotNetCorePath as %String (MAXLEN = 1023);

Property methods: DotNetCorePathDisplayToLogical(), DotNetCorePathGet(), DotNetCorePathIsValid(), DotNetCorePathLogicalToDisplay(), DotNetCorePathLogicalToOdbc(), DotNetCorePathNormalize(), DotNetCorePathSet()

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" ];

Property methods: DotNetVersionDisplayToLogical(), DotNetVersionGet(), DotNetVersionIsValid(), DotNetVersionLogicalToDisplay(), DotNetVersionLogicalToOdbc(), DotNetVersionNormalize(), DotNetVersionSet()

property Exec32 as %Boolean [ InitialExpression = 1 ];

Property methods: Exec32DisplayToLogical(), Exec32Get(), Exec32IsValid(), Exec32LogicalToDisplay(), Exec32Normalize(), Exec32Set()

property FilePath as %String (MAXLEN = 1023);

Property methods: FilePathDisplayToLogical(), FilePathGet(), FilePathIsValid(), FilePathLogicalToDisplay(), FilePathLogicalToOdbc(), FilePathNormalize(), FilePathSet()

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

Property methods: HeartbeatFailureActionDisplayToLogical(), HeartbeatFailureActionGet(), HeartbeatFailureActionIsValid(), HeartbeatFailureActionLogicalToDisplay(), HeartbeatFailureActionLogicalToOdbc(), HeartbeatFailureActionNormalize(), HeartbeatFailureActionSet()

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

Property methods: HeartbeatFailureRetryDisplayToLogical(), HeartbeatFailureRetryGet(), HeartbeatFailureRetryIsValid(), HeartbeatFailureRetryLogicalToDisplay(), HeartbeatFailureRetryNormalize(), HeartbeatFailureRetrySet()

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

Property methods: HeartbeatFailureTimeoutDisplayToLogical(), HeartbeatFailureTimeoutGet(), HeartbeatFailureTimeoutIsValid(), HeartbeatFailureTimeoutLogicalToDisplay(), HeartbeatFailureTimeoutNormalize(), HeartbeatFailureTimeoutSet()

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

Property methods: HeartbeatIntervalDisplayToLogical(), HeartbeatIntervalGet(), HeartbeatIntervalIsValid(), HeartbeatIntervalLogicalToDisplay(), HeartbeatIntervalNormalize(), HeartbeatIntervalSet()

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

Property methods: InitializationTimeoutDisplayToLogical(), InitializationTimeoutGet(), InitializationTimeoutIsValid(), InitializationTimeoutLogicalToDisplay(), InitializationTimeoutNormalize(), InitializationTimeoutSet()

property JVMArgs as %String (MAXLEN = 32000);

Property methods: JVMArgsDisplayToLogical(), JVMArgsGet(), JVMArgsIsValid(), JVMArgsLogicalToDisplay(), JVMArgsLogicalToOdbc(), JVMArgsNormalize(), JVMArgsSet()

property JavaHome as %String (MAXLEN = 1023);

Property methods: JavaHomeDisplayToLogical(), JavaHomeGet(), JavaHomeIsValid(), JavaHomeLogicalToDisplay(), JavaHomeLogicalToOdbc(), JavaHomeNormalize(), JavaHomeSet()

property LogFile as %String (MAXLEN = 1023);

Property methods: LogFileDisplayToLogical(), LogFileGet(), LogFileIsValid(), LogFileLogicalToDisplay(), LogFileLogicalToOdbc(), LogFileNormalize(), LogFileSet()

property MainClassName as %String [ InitialExpression = $$$javaGatewayClass ];

Property methods: MainClassNameDisplayToLogical(), MainClassNameGet(), MainClassNameIsValid(), MainClassNameLogicalToDisplay(), MainClassNameLogicalToOdbc(), MainClassNameNormalize(), MainClassNameSet()

property Name as %String [ Required ];

Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

property Port as %Integer (MAXVAL = 65535, MINVAL = 1) [ Required ];

Property methods: PortDisplayToLogical(), PortGet(), PortIsValid(), PortLogicalToDisplay(), PortNormalize(), PortSet()

property PyOptions as %String (MAXLEN = 32000);

Property methods: PyOptionsDisplayToLogical(), PyOptionsGet(), PyOptionsIsValid(), PyOptionsLogicalToDisplay(), PyOptionsLogicalToOdbc(), PyOptionsNormalize(), PyOptionsSet()

property PythonPath as %String (MAXLEN = 1023);

Property methods: PythonPathDisplayToLogical(), PythonPathGet(), PythonPathIsValid(), PythonPathLogicalToDisplay(), PythonPathLogicalToOdbc(), PythonPathNormalize(), PythonPathSet()

property PythonSDKVersion as %String (MAXLEN = 64);

Property methods: PythonSDKVersionDisplayToLogical(), PythonSDKVersionGet(), PythonSDKVersionIsValid(), PythonSDKVersionLogicalToDisplay(), PythonSDKVersionLogicalToOdbc(), PythonSDKVersionNormalize(), PythonSDKVersionSet()

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.

Property methods: ResourceDisplayToLogical(), ResourceGet(), ResourceIsValid(), ResourceLogicalToDisplay(), ResourceLogicalToOdbc(), ResourceNormalize(), ResourceSet()

property Server as %String [ InitialExpression = "127.0.0.1" , Required ];

Property methods: ServerDisplayToLogical(), ServerGet(), ServerIsValid(), ServerLogicalToDisplay(), ServerLogicalToOdbc(), ServerNormalize(), ServerSet()

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

Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()

property UsePassphrase as %Boolean [ InitialExpression = 1 ];

Property methods: UsePassphraseDisplayToLogical(), UsePassphraseGet(), UsePassphraseIsValid(), UsePassphraseLogicalToDisplay(), UsePassphraseNormalize(), UsePassphraseSet()

property passphraseList as %String [ Transient ];

Property methods: passphraseListDisplayToLogical(), passphraseListGet(), passphraseListIsValid(), passphraseListLogicalToDisplay(), passphraseListLogicalToOdbc(), passphraseListNormalize(), passphraseListSet()

Methods

classmethod %ExistsId(id As %String) as %Boolean

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.

classmethod GatewayExists(name As %String) as %Boolean

Check if there exists a Gateway with a given name.

method fromDao(dao As %Library.DynamicObject)

method toDao() as %Library.DynamicObject

Queries

query ByGateway()

Selects Name, Type, Server, Port, State, StateExt

Lookup all Gateways; include current state.

query ByName(name As %String = "")

Selects ID, Name, Type, Server, Port, Interface

Lookup by Gateway name.

Indexes

index (ID on Name) [IdKey, Type = key];

Index methods: IDCheck(), IDDelete(), IDExists(), IDOpen(), IDSQLCheckUnique(), IDSQLExists(), IDSQLFindPKeyByConstraint(), IDSQLFindRowIDByConstraint()