sharedGroupLog constructor parameter.
* * This class depends on {@link ActivateWrapper} to provide * separation of the import codebase * (where the service implementation classes are loaded from) * from the export codebase * (where service clients should load classes from, for example stubs) * as well as providing an independent security policy file for each * service object. This functionality allows multiple service objects * to be placed in the same activation system group, with each object * maintaining distinct export codebase and security policy settings. *
* Services need to implement the "activatable" * constructor * required by {@link ActivateWrapper}. *
*
* A service implementation
* can return its service proxy (via the proxy field of the
* {@link Created Created} object returned
* by {@link #create(net.jini.config.Configuration) create})
* in the following ways:
*
* The service's inner proxy is the * {@link java.rmi.Remote} object returned from * {@link java.rmi.activation.ActivationID#activate(boolean)} using * {@link ActivateWrapper} to "wrap" and register the desired service * with the activation system. * A "wrapped" service's inner proxy is returned as follows: * *
null, that proxy is returned in a
* {@link java.rmi.MarshalledObject}; otherwise, an
* {@link java.io.InvalidObjectException} is thrown.
*
* writeReplace
* method that returns the object's proxy).
* * The service's outer proxy is the object returned from invoking * {@link ServiceProxyAccessor#getServiceProxy()} on * the service's inner proxy. *
SharedActivatableServiceDescriptor
* depends on {@link ActivateWrapper}, which can itself be configured. See
* {@linkplain ActivateWrapper}'s
* configuration
* information for details.
*
* This implementation obtains its configuration entries from the
* {@link net.jini.config.Configuration Configuration} object passed into
* the {@link #create(net.jini.config.Configuration) create} method.
* The following configuration entries use the
* component prefix "com.sun.jini.start":
*
* *
| • * |
* activationIdPreparer
* | |
|---|---|---|
| * Type: | {@link net.jini.security.ProxyPreparer} * | |
| * Default: |
* new {@link net.jini.security.BasicProxyPreparer}()
*
* | |
| * Description: | The proxy preparer for the service's activation
* ID. The value should not be null.
*
* This class calls the
* {@link java.rmi.activation.ActivationID#activate
* activate} method on instances of {@link
* java.rmi.activation.ActivationID} when they need to re/activate the
* service.
* | |
| • * |
* activationSystemPreparer
* | |
|---|---|---|
| * Type: | {@link net.jini.security.ProxyPreparer} * | |
| * Default: |
* new {@link net.jini.security.BasicProxyPreparer}()
* | |
| * Description: | The proxy preparer for the proxy for the
* activation system. The value should not be null.
*
* The service starter calls the {@link
* java.rmi.activation.ActivationSystem#unregisterObject
* unregisterObject} method on the {@link
* java.rmi.activation.ActivationSystem} when there is a problem
* creating a service.
* | |
| • * |
* servicePreparer
* | |
|---|---|---|
| * Type: | {@link net.jini.security.ProxyPreparer} * | |
| * Default: |
* new {@link net.jini.security.BasicProxyPreparer}()
*
* | |
| * Description: | The default proxy preparer used to prepare
* service proxies.
* This value should not be null. This entry is
* obtained during the invocation of
* {@link #create(net.jini.config.Configuration) create} and is used,
* to prepare the inner and
* outer service proxies returned by
* the service implementation
* (see service proxy section for details).
* This entry is superseded by explicitly passing a
* {@link ProxyPreparer ProxyPreparer} to one of the constructors that
* accept a {@linkplain ProxyPreparer proxy preparer} argument.
* | |
com.sun.jini.start.service.starter.
* The following table describes the
* type of information logged as well as the levels of information logged.
* * *
| Level | Description * * |
|---|---|
| {@link java.util.logging.Level#FINER FINER} | * for high level * service operation tracing * |
| {@link java.util.logging.Level#FINEST FINEST} | * for low level * service operation tracing * * |
*
*
* @since 2.0
*
*/
public class SharedActivatableServiceDescriptor
extends NonActivatableServiceDescriptor
{
private static final long serialVersionUID = 1L;
/**
* @serial String representing the directory where
* the associated shared group identifier information is persisted
*/
private final String sharedGroupLog;
/**
* @serial boolean flag passed through as the
* restart parameter to the
* {@linkplain java.rmi.activation.ActivationDesc#ActivationDesc(java.rmi.activation.ActivationGroupID, java.lang.String, java.lang.String, java.rmi.MarshalledObject, boolean)
* ActivationDesc constructor} used to register the service with the
* activation system.
*/
private final boolean restart;
/**
* @serial String containing hostname of desired
* activation system.
*/
private final String host;
/**
* @serial int representing port of desired activation system.
*/
private final int port;
private static final Logger logger = ServiceStarter.logger;
/*
* ProxyPreparer reference for preparing the service's proxy
* returned from the call to
* {@linkplain java.rmi.activation.ActivationID#activate(boolean) activate}.
* If this "inner" proxy implements
* {@linkplain ServiceProxyAccessor ServiceProxyAccessor} it will then be used to invoke
* {@linkplain ServiceProxyAccessor#getServiceProxy() getServiceProxy}.
*/
private /*final*/ transient ProxyPreparer innerProxyPreparer;
/**
* Object returned by
* {@link SharedActivatableServiceDescriptor#create(net.jini.config.Configuration)
* SharedActivatableServiceDescriptor.create()}
* method that returns the associated proxy, activation group
* identifier, and activation identifier
* for the created service.
*/
public static class Created {
/** The activation group id of the group hosting the service */
public final ActivationGroupID gid;
/** The activation id of the service */
public final ActivationID aid;
/** The reference to the proxy of the created service */
public final Object proxy;
/** Constructs an instance of this class.
* @param gid activation group id of the created service
* @param aid activation id of the created service
* @param proxy reference to the proxy of the created service
*/
public Created(ActivationGroupID gid, ActivationID aid, Object proxy) {
this.gid = gid;
this.aid = aid;
this.proxy = proxy;
}//end constructor
}//end class Created
/**
* Convenience constructor. Equivalent to calling this
* {@link #SharedActivatableServiceDescriptor(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String[], net.jini.security.ProxyPreparer, net.jini.security.ProxyPreparer, boolean, java.lang.String, int) constructor}
* with the innerProxyPreparer, outerProxyPreparer
* and host arguments set to
* null
* and the port argument set to
* the currently configured activation system port.
* The activation system port defaults to
* {@link ActivationSystem#SYSTEM_PORT} unless it is overridden by the
* java.rmi.activation.port system property.
*
*/
public SharedActivatableServiceDescriptor(
// Required Args
String exportCodebase,
String policy,
String importCodebase,
String implClassName,
String sharedGroupLog,
// Optional Args,
String[] serverConfigArgs,
boolean restart)
{
this(exportCodebase, policy, importCodebase, implClassName,
sharedGroupLog, serverConfigArgs, null,
null, restart, null, ServiceStarter.getActivationSystemPort());
}
/**
* Convenience constructor. Equivalent to calling this
* {@link #SharedActivatableServiceDescriptor(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String[], net.jini.security.ProxyPreparer, net.jini.security.ProxyPreparer, boolean, java.lang.String, int) constructor}
* with the host argument set to
* null and the port argument set to the
* currently configured activation system port.
* The activation system port defaults to
* {@link ActivationSystem#SYSTEM_PORT} unless it is overridden by the
* java.rmi.activation.port system property.
*
*/
public SharedActivatableServiceDescriptor(
// Required Args
String exportCodebase,
String policy,
String importCodebase,
String implClassName,
String sharedGroupLog,
// Optional Args,
String[] serverConfigArgs,
ProxyPreparer innerProxyPreparer,
ProxyPreparer outerProxyPreparer,
boolean restart)
{
this(exportCodebase, policy, importCodebase, implClassName,
sharedGroupLog, serverConfigArgs, innerProxyPreparer,
outerProxyPreparer, restart, null, ServiceStarter.getActivationSystemPort());
}
/**
* Convenience constructor. Equivalent to calling this
* {@link #SharedActivatableServiceDescriptor(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String[], net.jini.security.ProxyPreparer, net.jini.security.ProxyPreparer, boolean, java.lang.String, int) constructor}
* with the innerProxyPreparer and outerProxyPreparer arguments set to
* null.
*/
public SharedActivatableServiceDescriptor(
// Required Args
String exportCodebase,
String policy,
String importCodebase,
String implClassName,
String sharedGroupLog,
// Optional Args,
String[] serverConfigArgs,
boolean restart,
String host,
int port)
{
this(exportCodebase, policy, importCodebase, implClassName,
sharedGroupLog, serverConfigArgs, null, null, restart,
host, port);
}
/**
* Main constructor. Simply assigns given parameters to
* their associated, internal fields unless otherwise noted.
*
* @param exportCodebase location where clients can download required
* service-related classes (for example, stubs, proxies, etc.).
* Codebase components must be separated by spaces in which
* each component is in URL format.
* @param policy server policy filename or URL
* @param importCodebase location where server implementation
* classes can be found.
* This String assumed (in order) to be either
* 1) a space delimited set of URL(s)
* representing a codebase or
* 2) a File.pathSeparator delimited set
* of class paths.
* @param implClassName name of server implementation class
* @param sharedGroupLog location where the associated shared
* group identifier information is persisted
* @param serverConfigArgs service configuration arguments
* @param innerProxyPreparer ProxyPreparer reference. This object
* will be used to prepare the service's inner proxy.
* If the inner proxy implements
* {@link ServiceProxyAccessor}
* it will then be used to invoke
* {@link ServiceProxyAccessor#getServiceProxy()} in order to get the
* service's outer proxy.
* @param outerProxyPreparer ProxyPreparer reference. This object
* will be used to prepare the service's
* outer proxy before it is returned to the caller of
* {@link SharedActivatableServiceDescriptor#create(net.jini.config.Configuration)}.
* @param restart boolean flag passed through as the
* restart parameter to the
* {@linkplain java.rmi.activation.ActivationDesc#ActivationDesc(java.rmi.activation.ActivationGroupID, java.lang.String, java.lang.String, java.rmi.MarshalledObject, boolean)
* ActivationDesc constructor} used to register the service with the
* activation system.
* @param host hostname of desired activation system. If null,
* defaults to the localhost.
* @param port port of desired activation system. If value is <= 0, then
* defaults to
* {@link java.rmi.activation.ActivationSystem#SYSTEM_PORT
* ActivationSystem.SYSTEM_PORT}.
*/
public SharedActivatableServiceDescriptor(
// Required Args
String exportCodebase,
String policy,
String importCodebase,
String implClassName,
String sharedGroupLog,
// Optional Args,
String[] serverConfigArgs,
ProxyPreparer innerProxyPreparer,
ProxyPreparer outerProxyPreparer,
boolean restart,
String host,
int port)
{
super(exportCodebase, policy, importCodebase, implClassName,
serverConfigArgs, outerProxyPreparer);
if ( sharedGroupLog == null)
throw new NullPointerException(
"Shared VM log cannot be null");
this.sharedGroupLog = sharedGroupLog;
this.restart = restart;
this.host = (host == null) ? "" : host;
this.port =
(port <= 0) ? ServiceStarter.getActivationSystemPort() : port;
this.innerProxyPreparer = innerProxyPreparer;
}
/**
* Shared group log accessor method.
*
* @return the Shared group log associated with this service descriptor.
*/
final public String getSharedGroupLog() { return sharedGroupLog; }
/**
* Restart accessor method.
*
* @return the restart mode associated with this service descriptor.
*/
final public boolean getRestart() { return restart; }
/**
* Activation system host accessor method.
*
* @return the activation system host associated with
* this service descriptor.
*/
final public String getActivationSystemHost() { return host; }
/**
* Activation system port accessor method.
*
* @return the activation system port associated with this service descriptor.
*/
final public int getActivationSystemPort() { return port; }
/**
* ProxyPreparer accessor method.
*
* @return the inner proxy preparer associated with
* this service descriptor.
*/
final public ProxyPreparer getInnerProxyPreparer() { return innerProxyPreparer; }
/**
* Sets the inner
* ProxyPreparer for this descriptor.
* This needs to
* be called on the service descriptor prior to calling
* create(). Useful for (re-)setting the
* the associated inner ProxyPreparer upon deserialization of
* the descriptor.
*
* @param pp The inner ProxyPreparer object to be
* associated with this service descriptor.
*
* @throws IllegalStateException if called after create() is invoked
*/
final public void setInnerProxyPreparer(ProxyPreparer pp) {
synchronized (descCreatedLock) {
if (descCreated) {
throw new IllegalStateException("Can't set ProxyPreparer after descriptor creation");
} else {
innerProxyPreparer = pp;
}
}
}
/**
* Method that attempts to create a service based on the service
* description information provided via constructor parameters.
*
* This method: *
ActivateWrapper.ActivateDesc with
* the provided constructor parameter information for the
* desired service
* ActivateWrapper.register(), which also
* activates the service instance.
* null then it is used
* null is used
*