DocBook|Search
Class Reference
%Net.Remote.Gateway
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%Net] >  [Remote] >  [Gateway]
Private  Storage  

class %Net.Remote.Gateway extends %RegisteredObject

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
16 8 22


Summary

Properties
Closed ClosedProxies CurrentDevice DBSRVProtocol DeviceStack
GatewayDevice Namespace Protocol

Methods
%%OIDGet %AddToCurrentClassPath %AddToSaveSet %ClassForName
%ClassIsLatestVersion %ClassName %Connect %ConstructClone
%DeregisterSuperServer %Disconnect %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %ExpressImport %Extends %GetAllClasses
%GetParameter %GetTimestamp %Import %IsA
%IsModified %LoadCOSClass %New %NormalizeObject
%ObjectModified %OnNew %OriginalNamespace %PackageName
%Ping %PopDeviceStack %PushDeviceStack %RegUpdate
%RegisterSuperServer %RemoveFromSaveSet %SerializeObject %SetModified
%SetStatus %Shutdown %TerminateAllSuperServers %TerminateSuperServer
%ValidateObject

Subclasses
%Net.Remote.Java.JavaGateway

Parameters

• final parameter ADDTOCURRENTCLASSPATH = "YP";
• final parameter CONNECT = "Y0";
Messages
• final parameter DISCONNECT = "Y4";
• final parameter EXCEPTIONRAISED = "Y5";
• final parameter EXECUTEMETHOD = "Y1";
• final parameter GENERATECLASSES = "Y2";
• final parameter GETAVAILABLECLASSES = "YC";
• final parameter GETOBJECT = "Y3";
• final parameter GETTIMESTAMP = "YT";
• final parameter LOADCOSCLASS = "YL";
• final parameter LOADJAVACLASS = "YZ";
• final parameter OBJECTCREATED = "Y9";
• final parameter PING = "YQ";
• final parameter PROTOCOLVERSION = 0;
• final parameter SHUTDOWN = "Y6";
• final parameter SUCCESS = "YY";

Properties

• property Closed as %Boolean;
• property ClosedProxies as list of %String(TRUNCATE=1);
• property CurrentDevice as %String(TRUNCATE=1);
• property DBSRVProtocol as %Integer;
• property DeviceStack as list of %String(TRUNCATE=1);
• property GatewayDevice as %String(TRUNCATE=1);
• property Namespace as %String(TRUNCATE=1);
• property Protocol as %Integer;

Methods

• final method %AddToCurrentClassPath(paths As %ListOfDataTypes) as %Status
Add to current classpath
• final method %ClassForName(className As %String) as %Status
Calls Class.forName
• final method %Connect(host As %String, port As %Integer, namespace As %String = $ZU(5), timeout As %Numeric = 5, additionalClassPaths As %ListOfDataTypes = "", sslConfiguration As %String = "") as %Status
Connect and handshake
• final classmethod %DeregisterSuperServer(port As %String, namespace As %String)
• final method %Disconnect() as %Status
Close the connection
• final classmethod %ExpressImport(name As %String, port As %Integer, host As %String = "127.0.0.1", silent As %Boolean = 0, additionalClassPaths As %ListOfDataTypes = "", exclusions As %ListOfDataTypes = "") as %ListOfDataTypes
• method %GetAllClasses(jarFileOrDirectoryName As %String, ByRef allClasses As %ListOfDataTypes) as %Status
• method %GetTimestamp()
• final method %Import(javaClass As %String, ByRef javaClasses As %ListOfDataTypes, additionalClassPaths As %ListOfDataTypes = "", exclusions As %ListOfDataTypes = "") as %Status
Creates all necessary proxy classes
• final classmethod %LoadCOSClass() as %Status
• method %OnNew() as %Status
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.

• final classmethod %Ping(host As %String, port As %Integer, timeout As %Numeric = 5) as %Status
Check if SuperServer still alive
• method %PopDeviceStack() as %String
• method %PushDeviceStack(io As %String)
• method %RegUpdate()
• final classmethod %RegisterSuperServer(port As %String, namespace As %String)
• classmethod %SetStatus(exception As %Exception.StatusException) as %Status
• final method %Shutdown() as %Status
Shut down the Gateway
• final classmethod %TerminateAllSuperServers()
• final classmethod %TerminateSuperServer(port As %String, namespace As %String, deregister As %Boolean)