org.apache.commons.jcs.auxiliary.remote.server

Class RemoteCacheServerFactory

java.lang.Object

org.apache.commons.jcs.auxiliary.remote.server.RemoteCacheServerFactory

All Implemented Interfaces:

IRemoteCacheConstants

public class RemoteCacheServerFactory
extends Object
implements IRemoteCacheConstants

Provides remote cache services. This creates remote cache servers and can proxy command line requests to a running server.

Field Summary

Fields inherited from interface org.apache.commons.jcs.auxiliary.remote.behavior.IRemoteCacheConstants

CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX, CACHE_SERVER_PREFIX, CUSTOM_RMI_SOCKET_FACTORY_PROPERTY_PREFIX, PROPERTY_PREFIX, REMOTE_ALLOW_CLUSTER_GET, REMOTE_CACHE_SERVICE_NAME, REMOTE_CACHE_SERVICE_PORT, REMOTE_CACHE_SERVICE_VAL, REMOTE_LOCAL_CLUSTER_CONSISTENCY, SOCKET_TIMEOUT_MILLIS, TOMCAT_ON, TOMCAT_XML

Method Summary

Modifier and Type	Method and Description
protected static ICacheEventLogger	configureCacheEventLogger(Properties props) Tries to get the event logger by new and old config styles.
protected static RMISocketFactory	configureObjectSpecificCustomFactory(Properties props) This configures an object specific custom factory.
protected static RemoteCacheServerAttributes	configureRemoteCacheServerAttributes(Properties prop) Configure.
static <K,V> RemoteCacheServer<K,V>	getRemoteCacheServer() This will allow you to get stats from the server, etc.
protected static String	getServiceName()
static void	main(String[] args) Creates an local RMI registry on the default port, starts up the remote cache server, and binds it to the registry.
protected static void	registerServer(String serviceName, Remote server) Registers the server with the registry.
protected static void	setServiceName(String serviceName)
static void	startup(String host, int port, Properties props) Starts up the remote cache server on this JVM, and binds it to the registry on the given host and port.
static void	startup(String host, int port, Properties props, String propFile) Deprecated. Use startup(String, int, Properties) instead
static void	startup(String host, int port, String propFile) Deprecated. Use startup(String, int, Properties) instead

Methods inherited from class java.lang.Object

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

Method Detail

getRemoteCacheServer

public static <K,V> RemoteCacheServer<K,V> getRemoteCacheServer()

This will allow you to get stats from the server, etc. Perhaps we should provide methods on the factory to do this instead.

A remote cache is either a local cache or a cluster cache.

Returns:

Returns the remoteCacheServer.

startup

@Deprecated
public static void startup(String host,
                                       int port,
                                       String propFile)
                                throws IOException

Deprecated. Use startup(String, int, Properties) instead

Starts up the remote cache server on this JVM, and binds it to the registry on the given host and port.

A remote cache is either a local cache or a cluster cache.

Parameters:

host - the host name

port - the port number

propFile - the remote cache hub configuration file

Throws:

IOException

startup

@Deprecated
public static void startup(String host,
                                       int port,
                                       Properties props,
                                       String propFile)
                                throws IOException

Deprecated. Use startup(String, int, Properties) instead

Starts up the remote cache server on this JVM, and binds it to the registry on the given host and port.

A remote cache is either a local cache or a cluster cache.

Parameters:

host - the host name

port - the port number

props - the remote cache hub configuration

propFile - the remote cache hub configuration file

Throws:

IOException

startup

public static void startup(String host,
                           int port,
                           Properties props)
                    throws IOException

Starts up the remote cache server on this JVM, and binds it to the registry on the given host and port.

A remote cache is either a local cache or a cluster cache.

Parameters:

host -

port -

props -

Throws:

IOException

configureCacheEventLogger

protected static ICacheEventLogger configureCacheEventLogger(Properties props)

Tries to get the event logger by new and old config styles.

Parameters:

props -

Returns:

ICacheEventLogger

configureObjectSpecificCustomFactory

protected static RMISocketFactory configureObjectSpecificCustomFactory(Properties props)

This configures an object specific custom factory. This will be configured for just this object in the registry. This can be null.

Parameters:

props -

Returns:

RMISocketFactory

registerServer

protected static void registerServer(String serviceName,
                                     Remote server)
                              throws RemoteException

Registers the server with the registry. I broke this off because we might want to have code that will restart a dead registry. It will need to rebind the server.

Parameters:

serviceName - the name of the service

server - the server object to bind

Throws:

RemoteException

configureRemoteCacheServerAttributes

protected static RemoteCacheServerAttributes configureRemoteCacheServerAttributes(Properties prop)

Configure.

jcs.remotecache.serverattributes.ATTRIBUTENAME=ATTRIBUTEVALUE

Parameters:

prop -

Returns:

RemoteCacheServerAttributesconfigureRemoteCacheServerAttributes

main

public static void main(String[] args)
                 throws Exception

Creates an local RMI registry on the default port, starts up the remote cache server, and binds it to the registry.

A remote cache is either a local cache or a cluster cache.

Parameters:

args - The command line arguments

Throws:

Exception

setServiceName

protected static void setServiceName(String serviceName)

Parameters:

serviceName - the serviceName to set

getServiceName

protected static String getServiceName()

Returns:

the serviceName