/*
* Copyright to the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.rioproject.impl.servicebean;
import com.sun.jini.config.Config;
import com.sun.jini.proxy.BasicProxyTrustVerifier;
import com.sun.jini.reliableLog.LogException;
import com.sun.jini.start.ServiceProxyAccessor;
import net.jini.config.Configuration;
import net.jini.config.ConfigurationException;
import net.jini.config.ConfigurationProvider;
import net.jini.config.NoSuchEntryException;
import net.jini.core.entry.Entry;
import net.jini.core.lease.Lease;
import net.jini.core.lease.LeaseDeniedException;
import net.jini.core.lookup.ServiceID;
import net.jini.export.Exporter;
import net.jini.export.ProxyAccessor;
import net.jini.id.Uuid;
import net.jini.id.UuidFactory;
import net.jini.lease.LeaseRenewalManager;
import net.jini.lookup.JoinManager;
import net.jini.lookup.entry.*;
import net.jini.lookup.ui.AdminUI;
import net.jini.security.TrustVerifier;
import net.jini.security.proxytrust.ServerProxyTrust;
import org.rioproject.RioVersion;
import org.rioproject.config.Constants;
import org.rioproject.deploy.ServiceBeanInstantiationException;
import org.rioproject.entry.*;
import org.rioproject.entry.ServiceInfo;
import org.rioproject.event.EventDescriptor;
import org.rioproject.event.EventHandler;
import org.rioproject.event.EventProducer;
import org.rioproject.impl.admin.ServiceAdminImpl;
import org.rioproject.impl.bean.BeanAdapter;
import org.rioproject.impl.config.ConfigHelper;
import org.rioproject.impl.config.ExporterConfig;
import org.rioproject.impl.container.DiscardManager;
import org.rioproject.impl.container.ServiceLogUtil;
import org.rioproject.impl.event.DispatchEventHandler;
import org.rioproject.impl.fdh.HeartbeatClient;
import org.rioproject.impl.jmx.JMXUtil;
import org.rioproject.impl.logging.ServiceLogEventPublisherImpl;
import org.rioproject.impl.persistence.PersistentStore;
import org.rioproject.impl.service.Joiner;
import org.rioproject.impl.service.LandlordLessor;
import org.rioproject.impl.service.ServiceProvider;
import org.rioproject.impl.service.ServiceResource;
import org.rioproject.impl.sla.SLAThresholdEventAdapter;
import org.rioproject.impl.system.ComputeResource;
import org.rioproject.impl.watch.WatchRegistry;
import org.rioproject.loader.ServiceClassLoader;
import org.rioproject.log.ServiceLogEvent;
import org.rioproject.logging.ServiceLogEventHandler;
import org.rioproject.logging.ServiceLogEventHandlerHelper;
import org.rioproject.opstring.ServiceElement;
import org.rioproject.resolver.Artifact;
import org.rioproject.servicebean.*;
import org.rioproject.serviceui.UIComponentFactory;
import org.rioproject.sla.SLAThresholdEvent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.management.*;
import javax.security.auth.Subject;
import javax.security.auth.login.LoginContext;
import javax.security.auth.login.LoginException;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.URL;
import java.net.UnknownHostException;
import java.rmi.Remote;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.security.PrivilegedActionException;
import java.security.PrivilegedExceptionAction;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;
/**
* The ServiceBeanAdapter implements the ServiceBean interface and provides the
* necessary service infrastructure to make a service developer successful.
* Extend this class to take advantage of the Rio ServiceBean capabilities
*
* @author Dennis Reedy
*/
@SuppressWarnings("PMD.EmptyMethodInAbstractClassShouldBeAbstract")
public abstract class ServiceBeanAdapter extends ServiceProvider implements
ServiceBean,
ServiceProxyAccessor,
ServerProxyTrust,
ProxyAccessor,
ServiceBeanAdapterMBean,
MBeanRegistration,
NotificationEmitter {
/**
* A ServiceBeanContext provides the ServiceBean with necessary context
* required to obtain information about it's environment, attributes and
* ServiceBeanManager instance
*/
protected ServiceBeanContext context;
/** The Uuid for the ServiceBean */
protected Uuid uuid;
/** The serviceID for the ServiceBean */
protected ServiceID serviceID;
/** The ServiceAdmin implementation for this ServiceBeanAdapter */
protected ServiceAdminImpl admin;
/**
* Joiner utility that contains a JoinManager and provides general utility
* to set the ServiceProvider's attribute collection
*/
protected Joiner joiner = new Joiner();
/** ServiceBean Remote Reference */
private Remote serviceBeanRemoteRef;
/**
* The proxy object for the service that will be registered into the lookup service
*/
protected Object proxy;
/** The Exporter for the ServiceBean */
private Exporter exporter;
/** A reference to the compute resource for this ServiceBean */
protected ComputeResource computeResource;
/** Thread that will do snapshots */
protected SnapshotThread snapshotter;
/** Manages persistence of the ServiceBeanContext */
protected ServiceBeanContextManager contextMgr;
/**
* PersistentStore the ServiceBeanContextManager uses to manage the state
* of the ServiceBeanContext
*/
protected PersistentStore store;
/** The state of the ServiceBean */
protected int state = 0;
/** Indicates the ServiceBean is being shutdown */
protected final AtomicBoolean inShutdown = new AtomicBoolean(false);
/**
* The ServiceElementChangeManager listens for updates to the
* ServiceElement by the ServiceBeanManager
*/
private ServiceElementChangeManager sElemChangeMgr;
/** EventHandler for dispatching SLAThresholdEvents */
private DispatchEventHandler slaEventHandler;
/**
* The Landlord which will manage leases being used for monitoring this
* service
*/
private LandlordLessor monitorLandlord;
/** The ServiceBeanState component, managing the state of the
* ServiceBean */
protected ServiceBeanState jsbState = new ServiceBeanState();
/**
* Component name we use to find items in the configuration. The value is
* set to the package name of the concrete implementation of this class.
* If the class has no package name, the component is the name of the class
*/
protected String serviceBeanComponent;
/** Logger */
static final Logger logger = LoggerFactory.getLogger(ServiceBeanAdapter.class);
/** The HeartbeatClient, which will manage sending heartbeat announcements */
private HeartbeatClient heartbeatClient;
/** Our login context, for logging out */
private LoginContext loginContext;
/** Indicates the maximum amount of time to wait for unexport attempts */
private long maxUnexportDelay;
/** Length of time to sleep between unexport attempts */
private long unexportRetryDelay;
/** When this service was created */
long started;
/* ObjectName used to register and unregister from mbean server */
protected ObjectName objectName;
/* MBean server we are registered to */
protected MBeanServer mbeanServer;
protected final List<MBeanNotificationInfo> mbeanNoticationInfoList =new ArrayList<MBeanNotificationInfo>();
protected SLAThresholdEventAdapter slaThresholdEventAdapter;
/**
* Construct a ServiceBeanAdapter
*/
public ServiceBeanAdapter() {
super();
started = System.currentTimeMillis();
if(getClass().getPackage()!=null)
serviceBeanComponent = getClass().getPackage().getName();
else
serviceBeanComponent = getClass().getName();
if(logger.isTraceEnabled())
logger.trace("Set configuration component name as : {}", serviceBeanComponent);
}
/**
* The start method provides the capability for a ServiceBean to initialize
* itself and make it ready to accept inbound communications, returning an
* Object which can be used to communicate with the ServiceBean. It is the
* responsibility of the ServiceBean to initiate appropriate startup logic.
* If the ServiceBean has started itself, subsequent invocations of this
* method will not re-start the ServiceBean, but return the Object created
* during the initial start
*
* @param context The ServiceBeanContext containing ServiceBean
* initialization attributes
* @return An Object that can be used to communicate to the ServiceBean
* @throws ServiceBeanInstantiationException If any errors or unexpected conditions occur
*/
public Object start(final ServiceBeanContext context) throws ServiceBeanInstantiationException {
if (context == null)
throw new IllegalArgumentException("ServiceBeanContext is null");
try {
Configuration config = context.getConfiguration();
try {
loginContext = (LoginContext)Config.getNonNullEntry(config,
serviceBeanComponent,
"loginContext",
LoginContext.class);
} catch (NoSuchEntryException e) {
// leave null
}
PrivilegedExceptionAction<Object> doStart =
new PrivilegedExceptionAction<Object>() {
public Object run() throws Exception {
return (doStart(context));
}
};
if (loginContext != null) {
loginContext.login();
try {
if(context instanceof DefaultServiceBeanContext)
((DefaultServiceBeanContext)context).setSubject(loginContext.getSubject());
Subject.doAsPrivileged(loginContext.getSubject(), doStart, null);
} catch (PrivilegedActionException e) {
throw e.getCause();
}
} else {
doStart.run();
}
} catch(Throwable t) {
/* If there is an exception starting, make sure to set the context. This is needed for
* subsequent logging */
this.context = context;
if(t instanceof ServiceBeanInstantiationException)
throw (ServiceBeanInstantiationException)t;
Throwable cause = getRootCause(t);
jsbState.setState(ServiceBeanState.ABORTED);
destroy(true);
if(cause instanceof ServiceBeanInstantiationException) {
throw (ServiceBeanInstantiationException)cause;
} else {
String message = String.format("ServiceBean %s instantiation failed",
ServiceLogUtil.logName(context.getServiceElement()));
throw new ServiceBeanInstantiationException(message, t, true);
}
}
return (proxy);
}
/*
* Get the root case
*/
private Throwable getRootCause(final Throwable thrown) {
Throwable cause = thrown;
Throwable t = cause;
while(t != null) {
t = cause.getCause();
if(t != null)
cause = t;
}
return (cause);
}
/*
* Perform the start after optionally establishing a LoginContext
*
* @param context The ServiceBeanContext
* @return An Object that can be used to communicate with the service
* @throws Exception
*/
private Object doStart(final ServiceBeanContext context) throws Exception {
if (jsbState.getState() < ServiceBeanState.STARTED) {
jsbState.setState(ServiceBeanState.STARTING);
BeanAdapter.invokeLifecycleInjectors(this, context);
/* Set the WatchRegistry for this ServiceProvider */
setWatchRegistry(context.getWatchRegistry());
/* Set the event table for this ServiceProvider */
if(context instanceof DefaultServiceBeanContext)
setEventTable(((DefaultServiceBeanContext)context).getEventTable());
else
logger.warn("Cannot set EventTable, context not a DefaultServiceBeanContext");
exporter = getExporter(context.getConfiguration());
serviceBeanRemoteRef = exportDo(exporter);
/* Initialize the ServiceBean */
proxy = null;
if (jsbState.getState() < ServiceBeanState.INITIALIZED) {
initialize(context);
jsbState.setState(ServiceBeanState.INITIALIZED);
} else {
getServiceProxy();
}
jsbState.setState(ServiceBeanState.STARTED);
}
return (proxy);
}
/**
* The initialize method is invoked to initialize the ServiceBean. This
* method is invoked only once. The ServiceBeanAdapter initializes
* required infrastructure elements in order to prepare the ServiceBean
* for processing.
*
* @param context The ServiceBeanContext to initialize the ServiceBean with
* @throws Exception If something unexpected happens
*/
public void initialize(final ServiceBeanContext context) throws Exception {
initialize(context, null);
}
/**
* The initialize method is invoked to initialize the ServiceBean. This
* method is invoked only once. The ServiceBeanAdapter initializes required
* infrastructure elements in order to prepare the ServiceBean for
* processing.
*
* @param context The ServiceBeanContext to initialize the ServiceBean. If
* this parameter is null a IllegalArgumentException is thrown
* @param store A PersistentStore which will be used as a basis to create
* a ServiceBeanContextManager used to manage the state of the
* ServiceBeanContext. If this parameter is null, a
* ServiceBeanContextManager will not be created
* @throws Exception If something unexpected happens
*/
public void initialize(final ServiceBeanContext context, final PersistentStore store)
throws Exception {
if (context == null)
throw new IllegalArgumentException("ServiceBeanContext is null");
if (store != null) {
this.store = store;
ServiceBeanManager jsbManager = context.getServiceBeanManager();
contextMgr = new ServiceBeanContextManager(context);
snapshotter = new SnapshotThread(this.getClass().getName());
ServiceBeanContext restoredContext = contextMgr.restoreContext(store);
this.context = (restoredContext == null ? context : restoredContext);
((DefaultServiceBeanContext) this.context).setServiceBeanManager(jsbManager);
snapshotter.start();
} else {
this.context = context;
}
/* Get the max unexport delay value */
maxUnexportDelay = Config.getLongEntry(context.getConfiguration(),
serviceBeanComponent,
"maxUnexportDelay",
5*1000, /* default is 5 seconds */
1, /* min is 1 second */
60*1000); /* max is 60 seconds */
unexportRetryDelay = Config.getLongEntry(context.getConfiguration(),
serviceBeanComponent,
"unexportRetryDelay",
1000, /* default is 1 second */
1, /* min is 1 second */
Long.MAX_VALUE);
Configuration config = context.getConfiguration();
/*
* Create the LandlordLessor for clients that desire to monitor this
* service
*/
monitorLandlord = new LandlordLessor(config);
/*
* Create an EventDescriptor for the SLAThresholdEvent and add it as an
* attribute. Create a DispatchEventHandler to handle the sending of
* SLAThresholdEvents
*/
EventDescriptor slaEventDesc = SLAThresholdEvent.getEventDescriptor();
slaEventHandler = new DispatchEventHandler(slaEventDesc, config);
getEventTable().put(slaEventDesc.eventID, slaEventHandler);
addAttribute(slaEventDesc);
ServiceLogEventHandler appender = ServiceLogEventHandlerHelper.findInstance();
if(appender!=null) {
applyServiceLogEventHandlerProperties(appender, config);
} else {
logger.error("Unable to obtain a ServiceLogEventHandler");
}
this.computeResource = context.getComputeResourceManager().getComputeResource();
/*
* Create a ServiceElementChangeManager to listen for updates to the
* ServiceElement object by the ServiceBeanManager
*/
sElemChangeMgr = new ServiceElementChangeManager();
context.getServiceBeanManager().addListener(sElemChangeMgr);
initializeJMX(context);
}
/*
* Apply settings for a {@link ServiceLogEventHandler}.
*
* @param s The {@code ServiceLogEventHandler}
* @param config Configuration to use
* @throws IOException
*/
private void applyServiceLogEventHandlerProperties(final ServiceLogEventHandler s, final Configuration config)
throws IOException {
if(s.getServiceLogEventPublisher()==null) {
EventDescriptor serviceLogEventDescriptor = ServiceLogEvent.getEventDescriptor();
EventHandler serviceLogEventHandler = new DispatchEventHandler(serviceLogEventDescriptor, config);
getEventTable().put(serviceLogEventDescriptor.eventID, serviceLogEventHandler);
ServiceLogEventPublisherImpl publisher = new ServiceLogEventPublisherImpl(serviceLogEventHandler,
(EventProducer)getExportedProxy());
s.setServiceLogEventPublisher(publisher);
addAttribute(serviceLogEventDescriptor);
}
}
/**
* Called from initialize() to prepare JMX resources such as registering with
* MBeanServer
*
* @param context The ServiceBeanContext
* @throws Exception If errors occur
*/
protected void initializeJMX(final ServiceBeanContext context) throws Exception {
ObjectName objectName = createObjectName(context);
MBeanServer mbeanServer = org.rioproject.impl.jmx.MBeanServerFactory.getMBeanServer();
registerMBean(objectName, mbeanServer);
//translate events to notifications
slaThresholdEventAdapter = new SLAThresholdEventAdapter(objectName, getNotificationBroadcasterSupport());
register(SLAThresholdEvent.getEventDescriptor(), slaThresholdEventAdapter, null, Long.MAX_VALUE);
//register notification info
mbeanNoticationInfoList.add(slaThresholdEventAdapter.getNotificationInfo());
if(context.getServiceElement().forkService() &&
System.getProperty(Constants.SERVICE_BEAN_EXEC_NAME)!=null) {
addAttributes(JMXUtil.getJMXConnectionEntries());
}
}
/**
* Register the service using the ObjectName to the MBeanServer
*
* @param oName The ObjectName to register
* @param mbeanServer The MBeanServer to use
*
* @throws NotCompliantMBeanException If the bean is not compliant
* @throws MBeanRegistrationException If the bean is already registered
* @throws InstanceAlreadyExistsException If the instance already exists
*/
protected void registerMBean(final ObjectName oName, final MBeanServer mbeanServer)
throws NotCompliantMBeanException, MBeanRegistrationException, InstanceAlreadyExistsException {
mbeanServer.registerMBean(this, oName);
}
/**
* Called from destroy() (or if the service bean is aborted during start)
* to cleanup JMX resources and unregister from MBeanServer
*/
protected void cleanJMX() {
if (mbeanServer != null && objectName != null) {
try {
mbeanServer.unregisterMBean(objectName);
} catch (InstanceNotFoundException e) {
logger.warn(e.toString());
} catch (MBeanRegistrationException e) {
logger.warn(e.toString());
} finally {
objectName = null;
}
}
}
/**
* Create JMX ObjectName used for MBeanServer registration
*
* @param context The ServiceBeanContext to use
* @return ObjectName used for registration
* @throws MalformedObjectNameException If there are errors creating the
* JMX object name
*/
protected ObjectName createObjectName(final ServiceBeanContext context) throws MalformedObjectNameException {
return JMXUtil.getObjectName(context, serviceBeanComponent, context.getServiceElement().getName());
}
/**
* Save registered objectName and MBeanServer as members
*
* @see javax.management.MBeanRegistration#preRegister(javax.management.MBeanServer, javax.management.ObjectName)
*/
public ObjectName preRegister(final MBeanServer mBeanServer, final ObjectName objectName) throws Exception {
this.objectName = objectName;
this.mbeanServer = mBeanServer;
return objectName;
}
/**
* Implemented as part of the contract for a
* {@link javax.management.MBeanRegistration}, empty implementation
*/
public void postRegister(final Boolean aBoolean) {
}
/**
* Implemented as part of the contract for a
* {@link javax.management.MBeanRegistration}, empty implementation
*/
public void preDeregister() throws Exception {
}
/**
* Called after unregistering from MBeanServer. Unreference JMX resources.
*
* @see javax.management.MBeanRegistration#postDeregister()
*/
public void postDeregister() {
mbeanServer = null;
objectName = null;
}
/**
* Get the ServiceBeanContext
*
* @return The ServiceBeanContext for the ServiceBean
*/
public ServiceBeanContext getServiceBeanContext() {
return context;
}
/**
* Get the Watch Ui (User Interface) UIDescriptor. This method will use
* watch-ui.jar as the JAR which contains the
* org.rioproject.watch.AccumulatorViewer class. If the
* org.rioproject.watch.AccumulatorViewer class is in a different JAR or
* the Watch UI is a different class, this method should overriden
*
* @return The Entry object describing the AccumulatorViewer UIDescriptor
* @throws IOException If errors occur creating the Entry
*/
protected Entry getWatchUI() throws IOException {
Entry uiDescriptor = null;
if(context.getExportCodebase()!=null) {
uiDescriptor =
UIDescriptorFactory.getUIDescriptor(
AdminUI.ROLE,
new UIComponentFactory(new URL("artifact:org.rioproject:watch-ui:"+RioVersion.VERSION),
"org.rioproject.watch.AccumulatorViewer"));
}
return uiDescriptor;
}
/**
* Get the Object created by the configured Exporter
*
* @return The Object used to communicate to this service
*/
protected Remote getExportedProxy() {
return (serviceBeanRemoteRef);
}
/**
* Create the Object (the proxy) to communicate with the ServiceBean. This
* method is called by the getServiceProxy() method if the proxy is
* <code>null</code> or the ServiceBean has not been started. The default
* semantic is to return the Remote Object created by the exporter.
*
* If a different Object (proxy) is required, concrete implementations of
* the ServiceBeanAdapter must override this method and set the desired
* Object, or declare the {@link org.rioproject.annotation.CreateProxy}
* annotation or declare the "createProxy(arg)" method
*
* @return The proxy to use
*/
protected Object createProxy() {
Remote remoteRef = getExportedProxy();
Object customProxy = BeanAdapter.getCustomProxy(this, remoteRef);
return customProxy==null?remoteRef:customProxy;
}
/**
* Get the Object (the proxy) to communicate with the ServiceBean. If the
* proxy is <tt>null</tt>, the <tt>createProxy</tt> method will be called
* to return the proxy to communicate to the ServiceBean.
*
* The proxy attribute will only be created <b><u>iff </u> </b> the
* proxy attribute is null.
*
* @return The Object used to communicate to this service
*/
public Object getServiceProxy() {
if (this.proxy == null) {
this.proxy = createProxy();
}
return (proxy);
}
/**
* @see net.jini.export.ProxyAccessor#getProxy()
*/
public Object getProxy() {
return(getExportedProxy());
}
/**
* Returns a <code>TrustVerifier</code> which can be used to verify that a
* given proxy to this service can be trusted
*/
public TrustVerifier getProxyVerifier() {
return (new BasicProxyTrustVerifier(serviceBeanRemoteRef));
}
/**
* Get the EventHandler that has been created to handle the sending of
* SLAThresholdEvent event objects to registered EventConsumer clients
*
* @return The EventHandler that has been created to handle
* the sending of SLAThresholdEvent events
*/
public EventHandler getSLAEventHandler() {
return (slaEventHandler);
}
/**
* Add an attribute to the Collection of attributes the Joiner utility
* maintains. If the ServiceBean is advertised, the new attribute will be
* added to the collection of attributes for the ServiceBean
*
* @param attribute Entry to add
*/
public void addAttribute(final Entry attribute) {
if (attribute == null) {
logger.trace("attribute is null");
return;
}
joiner.addAttribute(attribute);
if (jsbState.getState() == ServiceBeanState.ADVERTISED) {
JoinManager jMgr = getJoinManager();
if (jMgr != null)
jMgr.addAttributes(new Entry[]{attribute});
else
throw new IllegalArgumentException("JoinManager is null");
}
}
/**
* Add attributes to the Collection of attributes the Joiner utility
* maintains. If the ServiceBean is advertised, the new attributes will be
* added to the collection of attributes for the ServiceBean
*
* @param attributes Array of Entry attributes
*/
public void addAttributes(final Entry[] attributes) {
if (attributes == null)
throw new IllegalArgumentException("attributes are null");
for (Entry attribute : attributes)
addAttribute(attribute);
}
/**
* @see org.rioproject.impl.servicebean.ServiceBeanAdapterMBean#advertise()
*/
public void advertise() throws IOException {
if (jsbState.getState() == ServiceBeanState.ADVERTISED) {
logger.warn("Already advertised [{}]", ServiceElementUtil.getLoggingName(context));
return;
}
if(logger.isTraceEnabled())
logger.trace("[{}] verify transition", ServiceElementUtil.getLoggingName(context));
jsbState.verifyTransition(ServiceBeanState.ADVERTISED);
ArrayList<Entry> attrList = new ArrayList<Entry>();
/* 1. Add a UIDescriptor for the AccumulatorViewer */
Entry watchUI = getWatchUI();
if(watchUI!=null) {
attrList.add(watchUI);
}
/*
* Add attributes from the ServiceBeanContext to the collection of
* attributes the Joiner utility maintains
*/
/* 2. Create and add OperationalStringEntry */
String opStringName = context.getServiceElement().getOperationalStringName();
if (opStringName != null)
attrList.add(new OperationalStringEntry(opStringName));
/* 3. Create and add ComputeResourceInfo */
ComputeResourceInfo computeResourceInfo = new ComputeResourceInfo();
computeResourceInfo.initialize(computeResource.getAddress());
computeResourceInfo.hostName = computeResource.getHostName();
attrList.add(computeResourceInfo);
/* 4. Create and add Host */
Host host = new Host(computeResource.getHostName());
attrList.add(host);
/* 5. Create and add Name */
Name name = new Name(context.getServiceElement().getName());
attrList.add(name);
String comment = context.getServiceElement().getServiceBeanConfig().getComment();
/* 6. Create and add Comment */
if (comment != null)
attrList.add(new Comment(comment));
/* 7. Create and add StandardServiceType */
ServiceType sType = getServiceType(name.name, comment);
attrList.add(sType);
/*
* 8. If we have an artifact, get the version number from it and create
* the ServiceInfo
*/
net.jini.lookup.entry.ServiceInfo sInfo = getServiceInfo();
if(sInfo!=null)
attrList.add(sInfo);
attrList.add(getServiceInfo(sInfo));
/* Get any attribute added to the context*/
if(context instanceof DefaultServiceBeanContext) {
attrList.addAll(((DefaultServiceBeanContext)context).getAttributes());
}
attrList.addAll(context.getServiceBeanConfig().getAdditionalEntries());
if(logger.isTraceEnabled())
logger.trace("[{}] do the join", ServiceElementUtil.getLoggingName(context));
LeaseRenewalManager lrm = null;
/*
* The advertise call may be invoked via the MBeanServer. If it is, the
* context classloader will not be the classloader which loaded this
* bean. If the context classloader is not a ServiceClassLoader, then
* set the current context classloader to be the classloader which
* loaded this class. This is needed to load the configuration file
*/
final Thread currentThread = Thread.currentThread();
final ClassLoader cCL = AccessController.doPrivileged(
new PrivilegedAction<ClassLoader>() {
public ClassLoader run() {
return (currentThread.getContextClassLoader());
}
});
boolean swapCLs = !(cCL instanceof ServiceClassLoader);
try {
final ClassLoader myCL = AccessController.doPrivileged(
new PrivilegedAction<ClassLoader>() {
public ClassLoader run() {
return (getClass().getClassLoader());
}
});
if(swapCLs) {
AccessController.doPrivileged(new PrivilegedAction<ClassLoader>() {
public ClassLoader run() {
currentThread.setContextClassLoader(myCL);
return (null);
}
});
}
lrm = new LeaseRenewalManager(context.getConfiguration());
} catch(Exception e) {
logger.warn("Creating LeaseRenewalManager", e);
lrm = new LeaseRenewalManager();
} finally {
if(swapCLs) {
AccessController.doPrivileged(new PrivilegedAction<ClassLoader>() {
public ClassLoader run() {
currentThread.setContextClassLoader(cCL);
return (null);
}
});
}
}
if(serviceID==null) {
/* Get the Uuid*/
getUuid();
/* Create the ServiceID */
if(logger.isDebugEnabled())
logger.debug("Create ServiceID from UUID {}", uuid.toString());
serviceID = new ServiceID(uuid.getMostSignificantBits(), uuid.getLeastSignificantBits());
}
joiner.asyncJoin(getServiceProxy(),
serviceID,
attrList.toArray(new Entry[attrList.size()]),
context.getDiscoveryManagement(),
lrm);
if(logger.isTraceEnabled())
logger.trace("[{}] set state to ADVERTISED", ServiceElementUtil.getLoggingName(context));
jsbState.setState(ServiceBeanState.ADVERTISED);
}
protected ServiceType getServiceType(final String name, final String comment) {
StandardServiceType sType = new StandardServiceType();
sType.name = name;
if(comment!=null)
sType.description = comment;
return sType;
}
protected net.jini.lookup.entry.ServiceInfo getServiceInfo() {
net.jini.lookup.entry.ServiceInfo sInfo = null;
String artifact;
if(context.getServiceElement().getExportBundles()!=null &&
context.getServiceElement().getExportBundles().length>0) {
artifact = context.getServiceElement().getExportBundles()[0].getArtifact();
} else {
artifact = context.getServiceElement().getComponentBundle().getArtifact();
}
if(artifact!=null) {
String version = getVersionFromArtifact(artifact);
if(version!=null)
sInfo = new net.jini.lookup.entry.ServiceInfo(context.getServiceElement().getName(),
"",
"",
version,
"","");
}
return sInfo;
}
protected ServiceInfo getServiceInfo(net.jini.lookup.entry.ServiceInfo info) {
ServiceInfo serviceInfo = new ServiceInfo();
serviceInfo.initialize(context.getServiceElement().getName(), info==null?null:info.version);
return serviceInfo;
}
private String getVersionFromArtifact(final String a) {
String version = null;
try {
Artifact artifact = new Artifact(a);
version = artifact.getVersion();
} catch(IllegalArgumentException e) {
logger.warn("Unable to determine artifact version for {}", a);
}
return version;
}
/**
* @see org.rioproject.impl.servicebean.ServiceBeanAdapterMBean#unadvertise
*/
public void unadvertise() throws IOException {
if (jsbState.getState() != ServiceBeanState.ADVERTISED
|| jsbState.getState() == ServiceBeanState.UNADVERTISED
|| jsbState.isAborted())
return;
try {
if(joiner != null)
joiner.terminate();
} catch (Throwable t) {
logger.warn("Terminating Joiner", t);
} finally {
jsbState.setState(ServiceBeanState.UNADVERTISED);
}
}
/**
* The stop method informs the ServiceBean to unexport itself from any
* underlying distributed Object communication mechanisms making it
* incapable of accepting inbound communications
*
* @param force If true, unexports the ServiceBean even if there are
* pending or in-progress calls; if false, only unexports the ServiceBean
* if there are no pending or in-progress calls.
*
* If the <code>force</code> parameters is <code>false</code>, unexporting
* the ServiceBean will be governed by the following configuration
* properties:
* <ul>
* <li><tt>maxUnexportDelay</tt> Indicates the maximum amount of time to
* wait for unexport attempts
* <li><tt>unexportRetryDelay</tt> Length of time to sleep between unexport
* attempts
* </ul>
*
* @throws IllegalStateException If the state transition is illegal
*/
public void stop(final boolean force) {
if(jsbState.getState()!=ServiceBeanState.ABORTED)
jsbState.verifyTransition(ServiceBeanState.STOPPED);
UnexportTask unexportTask = new UnexportTask(exporter, force);
unexportTask.start();
try {
unexportTask.join();
} catch(InterruptedException e) {
logger.warn("UnexportTask interrupted");
} finally {
proxy = null;
if(jsbState.getState()!=ServiceBeanState.ABORTED)
jsbState.setState(ServiceBeanState.STOPPED);
}
/*
* Unexport the Landlordlessor maintaining any leases for monitoring
* clients
*/
if(monitorLandlord!=null)
monitorLandlord.stop(true);
}
/**
* Provide a concrete implementation of getAdmin
*
* @return A ServiceAdminProxy instance to administer the ServiceBean
*/
public Object getAdmin() {
Object adminProxy = null;
try {
if(admin == null) {
Exporter adminExporter = getAdminExporter();
if (contextMgr != null)
admin = new ServiceAdminImpl(this, adminExporter, contextMgr.getContextAttributeLogHandler());
else
admin = new ServiceAdminImpl(this, adminExporter);
}
admin.setServiceBeanContext(getServiceBeanContext());
adminProxy = admin.getServiceAdmin();
} catch (Throwable t) {
logger.error("Getting ServiceAdminImpl", t);
}
return (adminProxy);
}
/**
* Close down all WatchDataSource instances, unexporting them from the
* runtime
*/
protected void destroyWatches() {
WatchRegistry wr = getWatchRegistry();
if(wr!=null)
wr.closeAll();
}
/**
* @see org.rioproject.impl.servicebean.ServiceBeanAdapterMBean#destroy
*/
public void destroy() {
destroy(false);
}
/**
* @see org.rioproject.impl.servicebean.ServiceBeanAdapterMBean#destroy(boolean)
*/
public void destroy(final boolean force) {
if(logger.isInfoEnabled())
logger.info("Destroy {}", ServiceElementUtil.getLoggingName(context));
if (inShutdown.get())
return;
inShutdown.set(true);
if (snapshotter != null)
snapshotter.interrupt();
/* Unregister the ServiceElement observer */
if(sElemChangeMgr!=null) {
if(logger.isTraceEnabled())
logger.trace("[{}] Unregister from ServiceElement observer", ServiceElementUtil.getLoggingName(context));
context.getServiceBeanManager().removeListener(sElemChangeMgr);
sElemChangeMgr = null;
}
if (slaEventHandler != null) {
if(logger.isTraceEnabled())
logger.trace("[{}] Terminate the SLAEventHandler", ServiceElementUtil.getLoggingName(context));
slaEventHandler.terminate();
slaEventHandler = null;
}
/*
* Close down all WatchDataSource instances, unexporting them from the
* runtime
*/
destroyWatches();
/* No longer discoverable */
try {
if(logger.isTraceEnabled())
logger.trace("[{}] Unadvertise service", ServiceElementUtil.getLoggingName(context));
unadvertise();
} catch (IllegalStateException e) {
logger.warn("Error unadvertising service {}, continue on with destroy. {}: {}",
ServiceElementUtil.getLoggingName(context),
e.getClass().getName(), e.getLocalizedMessage());
} catch (IOException e) {
logger.warn("Error unadvertising service {}, continue on with destroy. {}: {}",
ServiceElementUtil.getLoggingName(context),
e.getClass().getName(), e.getLocalizedMessage());
}
/* Terminate DefaultAssociationManagement */
if(context!=null && context.getAssociationManagement()!=null) {
if(logger.isTraceEnabled())
logger.trace("[{}] Terminate DefaultAssociationManagement", ServiceElementUtil.getLoggingName(context));
context.getAssociationManagement().terminate();
}
/* If any PlatformCapability instances were added, remove them */
if(context instanceof DefaultServiceBeanContext)
((DefaultServiceBeanContext)context).removePlatformCapabilities();
/* If we're sending heartbeats, stop them */
if (heartbeatClient != null) {
if(logger.isTraceEnabled())
logger.trace("[{}] Terminating HeartbeatClient", ServiceElementUtil.getLoggingName(context));
heartbeatClient.terminate();
}
/* Terminate DiscoveryManagement */
try {
if(context!=null && context.getDiscoveryManagement()!=null) {
if(logger.isTraceEnabled())
logger.trace("[{}] Terminating DiscoveryManagement", ServiceElementUtil.getLoggingName(context));
context.getDiscoveryManagement().terminate();
}
} catch (Throwable t) {
logger.warn("DiscoveryManagement termination", t);
}
/* Unexport the ServiceAdmin */
if (admin != null) {
try {
if(logger.isTraceEnabled())
logger.trace("[{}] Unexport the ServiceAdmin", ServiceElementUtil.getLoggingName(context));
admin.unexport(true);
} catch (Exception e) {
logger.warn("Unexporting ServiceAdminImpl", e);
}
}
/* Unexport the service */
try {
if(System.getProperty("StaticCybernode")==null) {
if(logger.isTraceEnabled())
logger.trace("[{}] Unexport the service", ServiceElementUtil.getLoggingName(context));
stop(force);
}
} catch (IllegalStateException e) {
logger.warn("Stopping ServiceBean", e);
}
/* Logout */
if (loginContext != null) {
try {
loginContext.logout();
} catch (LoginException e) {
logger.warn("logout failed", e);
}
}
/* cleanup JMX */
cleanJMX();
/* Discard */
if(context!=null) {
if(logger.isTraceEnabled())
logger.trace("[{}] Discard the service", ServiceElementUtil.getLoggingName(context));
ServiceBeanManager serviceBeanManager = context.getServiceBeanManager();
if(serviceBeanManager != null) {
DiscardManager discardMgr = serviceBeanManager.getDiscardManager();
if (discardMgr != null) {
discardMgr.discard();
} else {
logger.warn("[{}] DiscardManager is null, unable to discard", ServiceElementUtil.getLoggingName(context));
}
} else {
if(logger.isTraceEnabled())
logger.trace("[{}] ServiceBeanManager is null, unable to discard", ServiceElementUtil.getLoggingName(context));
}
context = null;
}
admin = null;
serviceBeanRemoteRef = null;
proxy = null;
}
/**
* @see org.rioproject.admin.MonitorableService#monitor
*/
public Lease monitor(final long duration) throws LeaseDeniedException {
if (duration <= 0)
throw new LeaseDeniedException("lease duration of ["+duration+"] is invalid");
String phonyResource = this.getClass().getName() + ":"+ System.currentTimeMillis();
ServiceResource serviceResource = new ServiceResource(phonyResource);
Lease lease = monitorLandlord.newLease(serviceResource, duration);
return (lease);
}
/**
* @see org.rioproject.admin.MonitorableService#startHeartbeat
*/
public void startHeartbeat(final String[] configArgs) throws ConfigurationException {
if (heartbeatClient == null)
heartbeatClient = new HeartbeatClient(uuid);
heartbeatClient.addHeartbeatServer(configArgs);
}
/**
* @see org.rioproject.admin.MonitorableService#ping
*/
public void ping() {
}
/**
* Get the Uuid
*/
public Uuid getUuid() {
if (uuid != null)
return (uuid);
ServiceBeanManager mgr = context.getServiceBeanManager();
uuid = mgr.getServiceID();
if (uuid == null) {
logger.debug("UUID is unknown, generate new UUID");
uuid = UuidFactory.generate();
if (mgr instanceof DefaultServiceBeanManager) {
((DefaultServiceBeanManager)mgr).setServiceID(uuid);
} else {
logger.debug("ServiceBeanManager is not a DefaultServiceBeanManager, cannot set UUID");
}
}
return (uuid);
}
/**
* Get the Uuid of the Cybernode
*
* @return The Uuid of the Cybernode
*/
public Uuid getServiceBeanInstantiatorUuid() {
return(context.getServiceBeanManager().getServiceBeanInstance().getServiceBeanInstantiatorID());
}
/**
* Get the JoinManager created by the Joiner utility
*
* @return The JoinManager created by the Joiner. May be null
*/
public JoinManager getJoinManager() {
return (joiner.getJoinManager());
}
/**
* Get the configured Exporter
*
* @param config The configuration to obtain
* @return An Exporter which can be used to export the service. If no
* Exporter has been configured, a new BasicJeriExporter with
* <ul>
* <li>A TcpServerEndpoint created on a random port,
* <li>a BasicILFactory,
* <li>distributed garbage collection turned off,
* <li>keep alive on.
* </ul>
* @throws Exception If there are errors getting the Exporter
*/
protected Exporter getExporter(final Configuration config) throws Exception {
if(config==null)
throw new IllegalArgumentException("config is null");
Exporter exporter = ExporterConfig.getExporter(config, serviceBeanComponent, "serverExporter");
return(exporter);
}
/**
* This method exports the remote object making it available to receive
* incoming calls
*
* @param exporter The Exporter to use, must not be null
*
* @return Remote The remote object used to accept incoming calls
*
* @throws Exception If errors occur
*/
protected Remote exportDo(final Exporter exporter) throws Exception {
if(exporter==null)
throw new IllegalArgumentException("exporter is null");
return(exporter.export(this));
}
/**
* @see org.rioproject.impl.servicebean.ServiceBeanAdapterMBean#getStarted
*/
public Date getStarted() {
return(new Date(getStartTime()));
}
public long getStartTime() {
return(started);
}
/**
* @see org.rioproject.impl.servicebean.ServiceBeanAdapterMBean#getLookupGroups
*/
public String[] getLookupGroups() {
return (admin.getLookupGroups());
}
/**
* @see org.rioproject.impl.servicebean.ServiceBeanAdapterMBean#setLookupGroups
*/
public void setLookupGroups(final String[] groups) {
admin.setLookupGroups(groups);
}
/**
* Get the Exporter to export the ServiceAdmin
*
* @return The Exporter obtained from the Configuration matching the
* package name of the concrete implementation of this class with the name
* adminExporter
*
* @throws ConfigurationException If there are errors reading the
* configuration
* @throws UnknownHostException If the host is unknown
*/
protected Exporter getAdminExporter() throws ConfigurationException, UnknownHostException {
Exporter adminExporter = null;
if(context!=null) {
adminExporter = ExporterConfig.getExporter(context.getConfiguration(),
serviceBeanComponent,
"adminExporter");
if(logger.isDebugEnabled())
logger.debug("[{}] using admin exporter: {}",
ServiceElementUtil.getLoggingName(context), adminExporter.toString());
}
return(adminExporter);
}
public void removeNotificationListener(final NotificationListener listener,
final NotificationFilter filter,
final Object object) throws ListenerNotFoundException {
getNotificationBroadcasterSupport().removeNotificationListener(listener, filter, object);
}
public void addNotificationListener(final NotificationListener listener,
final NotificationFilter filter,
final Object object) {
getNotificationBroadcasterSupport().addNotificationListener(listener, filter, object);
}
public void removeNotificationListener(final NotificationListener listener) throws ListenerNotFoundException {
getNotificationBroadcasterSupport().removeNotificationListener(listener);
}
public MBeanNotificationInfo[] getNotificationInfo() {
return (mbeanNoticationInfoList.toArray(new MBeanNotificationInfo[mbeanNoticationInfoList.size()]));
}
public NotificationBroadcasterSupport getNotificationBroadcasterSupport() {
return context.getServiceBeanManager().getNotificationBroadcasterSupport();
}
/**
* Class which will handle the unexport in a Thread
*/
private class UnexportTask extends Thread {
Exporter exporter;
boolean force;
UnexportTask(final Exporter exporter, final boolean force) {
super("UnexportTask");
this.exporter = exporter;
this.force = force;
}
public void run() {
boolean unexported = false;
long start = System.currentTimeMillis();
if(!force) {
if(logger.isTraceEnabled())
logger.trace("Unexporting {}, maxUnexportDelay={}, unexportRetryDelay={}",
ServiceElementUtil.getLoggingName(context), maxUnexportDelay, unexportRetryDelay);
/*
final long end_time = start + maxUnexportDelay;
while(!unexported && (System.currentTimeMillis() < end_time)) {
unexported = unexportDo(false);
if (!unexported) {
Thread.yield();
}
}
*/
long now = System.currentTimeMillis();
long end_time = now+maxUnexportDelay;
if(end_time < 0) {
// overflow
end_time = Long.MAX_VALUE;
}
//boolean unexported = false;
while((!unexported) && (now < end_time)) {
/* wait for any pending operations to complete */
unexported = exporter.unexport(false);
if(!unexported) {
try {
/* Sleep for a finite time instead of yield.
* In most VMs yield is a no-op so if
* unexport(false) is not working (say because
* there is a blocking query in progress) a
* yield here results in a very tight loop
* (plus there may be no other runnable threads)
*/
final long sleepTime = Math.min(unexportRetryDelay, end_time-now);
/* sleepTime must > 0, unexportRetryDelay is
* > 0 and if now >= end_time we would have
* fallen out of the loop
*/
sleep(sleepTime);
now = System.currentTimeMillis();
} catch(InterruptedException e) {
// should never happen, but if it does break
// and fall through to force = true case
logger.warn("exception encountered unexport retry delay sleep, continuing", e);
break;
}
}
}
}
if(!unexported) {
unexported = unexportDo(true);
}
if(logger.isTraceEnabled()) {
logger.trace("Unexported {}, [{}] time allotted {} milliseconds",
ServiceElementUtil.getLoggingName(context),
unexported,
(System.currentTimeMillis() - start));
}
}
boolean unexportDo(final boolean force) {
boolean result = exporter==null;
try {
if(exporter!=null)
result = exporter.unexport(force);
} catch (Exception e) {
logger.warn("Unexporting ServiceBean", e);
}
return(result);
}
}
/**
* The ServiceElementChangeManager listens for changes made to the
* ServiceElement by the ServiceBeanManager
*/
class ServiceElementChangeManager implements ServiceElementChangeListener {
/**
* @see org.rioproject.servicebean.ServiceElementChangeListener#changed
*/
public void changed(final ServiceElement preElem, final ServiceElement postElem) {
/* --- Check for different ServiceUI --- */
/* Get the current attribute collection from JoinManager, and extract
* ServiceUI entries
*/
if(joiner.getJoinManager()!=null) {
ArrayList<Entry> suiList = new ArrayList<Entry>();
Entry[] current = joiner.getJoinManager().getAttributes();
for (Entry aCurrent : current) {
if (aCurrent instanceof UIDescriptor)
suiList.add(aCurrent);
}
Entry[] suiEntries = suiList.toArray(new Entry[suiList.size()]);
if(ServiceElementUtil.hasDifferentServiceUIs(suiEntries, postElem, context.getExportCodebase())) {
try {
/* Using the current attribute collection, remove all
* ServiceUI entries, then add the new entries and modify
* the service's attribute set with the changed serviceUIs
*/
ArrayList<Entry> eList = new ArrayList<Entry>();
for (Entry aCurrent : current) {
if (!(aCurrent instanceof UIDescriptor)) {
eList.add(aCurrent);
}
}
/* Add the Watch UI */
try {
eList.add(getWatchUI());
} catch(Exception e1) {
logger.warn("Getting Watch UI", e1);
}
String[] args = ConfigHelper.getConfigArgs(postElem);
Configuration config = ConfigurationProvider.getInstance(args);
Entry[] serviceUIs = (Entry[])config.getEntry(serviceBeanComponent,
"serviceUIs",
Entry[].class,
new Entry[0],
context.getExportCodebase());
/* Add configured seviceUIs */
eList.addAll(Arrays.asList(serviceUIs));
Entry[] attrs = eList.toArray(new Entry[eList.size()]);
/* Check again, the service may have gone to an
* unadvertised state */
if(joiner.getJoinManager()!=null)
joiner.getJoinManager().setAttributes(attrs);
} catch (ConfigurationException e) {
logger.warn("Getting or Applying modified ServiceUIs", e);
} catch (IOException e) {
logger.warn("Getting or Applying modified ServiceUIs", e);
}
}
}
}
}
/**
* A Thread that will perform snapshots. Snapshots, done in a separate
* thread so it will not hang up in progress remote calls
*/
public class SnapshotThread extends Thread {
SnapshotThread(final String name) {
super(name + ":SnapshotThread");
setDaemon(true);
}
/**
* Signal this thread that it should take a snapshot
*/
/*public synchronized void takeSnapshot() {
notifyAll();
}*/
public void run() {
while (!isInterrupted()) {
synchronized (this) {
try {
wait();
} catch (InterruptedException e) {
return;
}
}
try {
store.snapshot();
} catch (InterruptedIOException e) {
// Someone wants us dead
return;
} catch (Exception e) {
if (e instanceof LogException
&& ((LogException) e).detail instanceof
InterruptedIOException)
return;
/*
* If taking the snapshot fails for any reason, then one of
* the following must be done: -- output the problem to a
* file and exit -- output the problem to a file and
* continue -- set an "I have a problem" attribute and then
* send a notification this issue will be addressed at a
* later time
*/
logger.warn("Snapshotting ServiceBean", e);
}
}
}
}
}