org.cristalise.kernel.process

Class Gateway

java.lang.Object

org.cristalise.kernel.process.Gateway

public class Gateway
extends Object

The Gateway is the central object of a CRISTAL process. It initializes, maintains and shuts down every other subsystem in both the client and the server. Child objects:

• Lookup - Provides access to the CRISTAL directory. Find or search for Items or Agents.
• ProxyManager - Gives a local proxy object for Entities found in the directory. Execute activities in Items, query or subscribe to Entity data.
• TransactionManager - Access to the configured CRISTAL databases
• CorbaServer - Manages the memory pool of active Entities
• ORB - the CORBA ORB

Version:

$Revision: 1.17 $

Author:

$Author: abranson $ $Date: 2005/10/12 12:51:54 $

Method Summary

Methods

Modifier and Type	Method and Description
static void	close() Shuts down all kernel api objects
static Authenticator	connect() Connects to the LDAP server in an administrative context - using the admin username and password given in the LDAP.user and LDAP.password props of the kernel properties.
static AgentProxy	connect(String agentName, String agentPassword)
static AgentProxy	connect(String agentName, String agentPassword, String resource) Logs in with the given username and password, and initialises the lookup, storage and proxy manager.
static void	dumpC2KProps(int logLevel)
static Authenticator	getAuthenticator()
static String	getCentreId()
static CorbaServer	getCorbaServer()
static String	getKernelVersion()
static Lookup	getLookup()
static LookupManager	getLookupManager()
static CastorXMLUtility	getMarshaller()
static ModuleManager	getModuleManager()
static ORB	getORB()
static ObjectProperties	getProperties()
static ProxyManager	getProxyManager()
static ProxyServer	getProxyServer()
static ResourceLoader	getResource()
static TransactionManager	getStorage()
static void	init(Properties props) Initialises the Gateway and all of the client objects it holds, with the exception of the Lookup, which is initialised during connect()
static void	init(Properties props, ResourceLoader res) Initialises the Gateway and all of the client objects it holds, with the exception of the Lookup, which is initialised during connect()
static AgentProxy	login(String agentName, String agentPassword, String resource)
static Enumeration<?>	propertyNames()
static void	startServer(Authenticator auth) Makes this process capable of creating and managing server entities.

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init(Properties props)
                 throws InvalidDataException

Initialises the Gateway and all of the client objects it holds, with the exception of the Lookup, which is initialised during connect()

Parameters:

props - - java.util.Properties containing all application properties. If null, the java system properties are used

Throws:

InvalidDataException - - invalid properties caused a failure in initialisation

init

public static void init(Properties props,
        ResourceLoader res)
                 throws InvalidDataException

Initialises the Gateway and all of the client objects it holds, with the exception of the Lookup, which is initialised during connect()

Parameters:

props - - java.util.Properties containing all application properties. If null, the java system properties are used

res - - ResourceLoader for the kernel to use to resolve all class resource requests such as for bootstrap descriptions and version information

Throws:

InvalidDataException - - invalid properties caused a failure in initialisation

startServer

public static void startServer(Authenticator auth)
                        throws InvalidDataException,
                               CannotManageException

Makes this process capable of creating and managing server entities. Runs the bootstrap to create the root LDAP contexts, initialises the CORBA server and time-out manager.

Throws:

InvalidDataException - - error initialising

CannotManageException

getModuleManager

public static ModuleManager getModuleManager()

connect

public static Authenticator connect()
                             throws InvalidDataException,
                                    PersistencyException

Connects to the LDAP server in an administrative context - using the admin username and password given in the LDAP.user and LDAP.password props of the kernel properties.

Throws:

InvalidDataException - - bad params

PersistencyException - - error starting storages

connect

public static AgentProxy connect(String agentName,
                 String agentPassword,
                 String resource)
                          throws InvalidDataException,
                                 ObjectNotFoundException,
                                 PersistencyException

Logs in with the given username and password, and initialises the lookup, storage and proxy manager.

Parameters:

agentName - - username

agentPassword - - password

Returns:

an AgentProxy on the requested user

Throws:

InvalidDataException

PersistencyException

ClassNotFoundException

IllegalAccessException

InstantiationException

ObjectNotFoundException

login

public static AgentProxy login(String agentName,
               String agentPassword,
               String resource)
                        throws InvalidDataException,
                               ObjectNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

getAuthenticator

public static Authenticator getAuthenticator()
                                      throws InvalidDataException

Throws:

InvalidDataException

connect

public static AgentProxy connect(String agentName,
                 String agentPassword)
                          throws InvalidDataException,
                                 ObjectNotFoundException,
                                 PersistencyException,
                                 InstantiationException,
                                 IllegalAccessException,
                                 ClassNotFoundException

Throws:

InvalidDataException

ObjectNotFoundException

PersistencyException

InstantiationException

IllegalAccessException

ClassNotFoundException

close

public static void close()

Shuts down all kernel api objects

getORB

public static ORB getORB()

getLookup

public static Lookup getLookup()

getLookupManager

public static LookupManager getLookupManager()
                                      throws CannotManageException

Throws:

CannotManageException

getCorbaServer

public static CorbaServer getCorbaServer()

getStorage

public static TransactionManager getStorage()

getMarshaller

public static CastorXMLUtility getMarshaller()

getResource

public static ResourceLoader getResource()

getProxyManager

public static ProxyManager getProxyManager()

getProxyServer

public static ProxyServer getProxyServer()

getCentreId

public static String getCentreId()

propertyNames

public static Enumeration<?> propertyNames()

dumpC2KProps

public static void dumpC2KProps(int logLevel)

getProperties

public static ObjectProperties getProperties()

getKernelVersion

public static String getKernelVersion()