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

Method Summary

Modifier and Type	Method and Description
static void	close() Shuts down all kernel API objects
static Authenticator	connect() Connects to the Lookup server in an administrative context - using the admin username and password available in the implementation of the Authenticator.
static AgentProxy	connect(String agentName, String agentPassword) Log in with the given username and password, and initialises the Lookup, TransactionManager and ProxyManager.
static AgentProxy	connect(String agentName, String agentPassword, String resource) Log in with the given username and password, and initialises the Lookup, TransactionManager and ProxyManager.
static void	dumpC2KProps(int logLevel)
static Authenticator	getAuthenticator() Deprecated. use {getSecurityManager()} instead if you need to authenticate
static String	getCentreId()
static CorbaServer	getCorbaServer()
static String	getKernelVersion()
static Lookup	getLookup()
static LookupManager	getLookupManager()
static CastorXMLUtility	getMarshaller()
static ModuleManager	getModuleManager() Static getter for ModuleManager
static ORB	getORB() Returns the initialised CORBA ORB Object
static ObjectProperties	getProperties()
static ProxyManager	getProxyManager()
static ProxyServer	getProxyServer()
static ResourceLoader	getResource()
static ResourceImportHandler	getResourceImportHandler(BuiltInResources resType) Retrieves the ResourceImportHandler available for the resource type.
static ResourceImportHandler	getResourceImportHandler(String resType) Deprecated.
static SecurityManager	getSecurityManager()
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) Deprecated. use SecurityManager.authenticate(String, String, String)
static Enumeration<?>	propertyNames()
static void	runBoostrap() Run the different kind of Boostrap processes
static void	startServer() Makes this process capable of creating and managing server entities.
static void	startServer(Authenticator auth) Deprecated.

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

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

Deprecated.

Makes this process capable of creating and managing server entities. Runs the Creates the LookupManager, ProxyServer, initialises the ORB and CORBAServer

Parameters:

auth - - this is NOT USED

Throws:

InvalidDataException

CannotManageException

startServer

public static void startServer()
                        throws InvalidDataException,
                               CannotManageException

Makes this process capable of creating and managing server entities. Runs the Creates the LookupManager, ProxyServer, initialises the ORB and CORBAServer

Throws:

InvalidDataException

CannotManageException

getModuleManager

public static ModuleManager getModuleManager()

Static getter for ModuleManager

Returns:

ModuleManager

connect

public static Authenticator connect()
                             throws InvalidDataException,
                                    PersistencyException,
                                    ObjectNotFoundException

Connects to the Lookup server in an administrative context - using the admin username and password available in the implementation of the Authenticator. It shall be used in server processes only.

Throws:

InvalidDataException - - bad params

PersistencyException - - error starting storages

ObjectNotFoundException - - object not found

connect

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

Log in with the given username and password, and initialises the Lookup, TransactionManager and ProxyManager. It shall be uses in client processes only.

Parameters:

agentName - - username

agentPassword - - password

Returns:

an AgentProxy on the requested user

Throws:

InvalidDataException - - bad params

PersistencyException - - error starting storages

ObjectNotFoundException - - object not found

connect

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

Log in with the given username and password, and initialises the Lookup, TransactionManager and ProxyManager. It shall be uses in client processes only.

Parameters:

agentName - - username

agentPassword - - password

resource - - resource

Returns:

an AgentProxy on the requested user

Throws:

InvalidDataException - - bad params

PersistencyException - - error starting storages

ObjectNotFoundException - - object not found

login

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

Deprecated. use SecurityManager.authenticate(String, String, String)

Authenticates the agent

Parameters:

agentName - the name of the agent

agentPassword - the password of the agent

resource - check Authenticator.authenticate(String, String, String)

Returns:

AgentProxy representing the logged in user/agent

Throws:

InvalidDataException - - bad params

ObjectNotFoundException - - object not found

getAuthenticator

@Deprecated
public static Authenticator getAuthenticator()
                                                  throws InvalidDataException

Deprecated. use {getSecurityManager()} instead if you need to authenticate

Get the Authenticator instance

Returns:

the Authenticator

Throws:

InvalidDataException - in case of ClassNotFoundException or InstantiationException or IllegalAccessException

close

public static void close()

Shuts down all kernel API objects

getORB

public static ORB getORB()

Returns the initialised CORBA ORB Object

Returns:

the CORBA ORB Object

getSecurityManager

public static SecurityManager getSecurityManager()

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()

getResourceImportHandler

@Deprecated
public static ResourceImportHandler getResourceImportHandler(String resType)
                                                                  throws Exception

Deprecated.

Retrieves the ResourceImportHandler available for the resource type. It creates a new if configured or falls back to the default one provided in the kernel

Parameters:

resType - the type o the Resource. ie. one of these values: OD/SC/SM/EA/CA/QL

Returns:

the initialised ResourceImportHandler

Throws:

Exception

getResourceImportHandler

public static ResourceImportHandler getResourceImportHandler(BuiltInResources resType)
                                                      throws Exception

Retrieves the ResourceImportHandler available for the resource type. It creates a new if configured or falls back to the default one provided in the kernel

Parameters:

resType - the type o the Resource

Returns:

the initialised ResourceImportHandler

Throws:

Exception

runBoostrap

public static void runBoostrap()
                        throws Exception

Run the different kind of Boostrap processes

Throws:

Exception - anything could happen