001: /******************************************************************************
002: * JBoss, a division of Red Hat *
003: * Copyright 2006, Red Hat Middleware, LLC, and individual *
004: * contributors as indicated by the @authors tag. See the *
005: * copyright.txt in the distribution for a full listing of *
006: * individual contributors. *
007: * *
008: * This is free software; you can redistribute it and/or modify it *
009: * under the terms of the GNU Lesser General Public License as *
010: * published by the Free Software Foundation; either version 2.1 of *
011: * the License, or (at your option) any later version. *
012: * *
013: * This software is distributed in the hope that it will be useful, *
014: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
015: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
016: * Lesser General Public License for more details. *
017: * *
018: * You should have received a copy of the GNU Lesser General Public *
019: * License along with this software; if not, write to the Free *
020: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
021: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
022: ******************************************************************************/package org.jboss.portal.jems.ha;
023:
024: import org.jboss.ha.singleton.HASingletonMBean;
025:
026: import javax.management.ObjectName;
027: import java.util.Properties;
028:
029: /**
030: * The ha singleton invoker service extends the ha singleton service and adds the capability to invoke the singleton
031: * service from the cluster.
032: *
033: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
034: * @version $Revision: 8784 $
035: */
036: public interface HASingletonInvokerMBean extends HASingletonMBean {
037:
038: /** Get the callback of the invoker. */
039: HASingletonInvoker.Callback getCallback();
040:
041: /** @see #getCallback() */
042: void setCallback(HASingletonInvoker.Callback callback);
043:
044: /** Return the JNDI name under which the proxy is bound. */
045: String getJNDIName();
046:
047: /** @see #getJNDIName() */
048: void setJNDIName(String jndiName);
049:
050: /** Return the name of the proxy factory to use. */
051: ObjectName getProxyFactory();
052:
053: /** @see #getProxyFactory() */
054: void setProxyFactory(ObjectName proxyFactory);
055:
056: /** Return the JNDI configuration to lookup the proxy. */
057: Properties getJNDIProperties();
058:
059: /** @see #getJNDIProperties() */
060: void setJNDIProperties(Properties jndiProperties);
061:
062: /** Return the max number of retries when an invocation is done. */
063: int getMaxRetries();
064:
065: /** @see #getMaxRetries() */
066: void setMaxRetries(int maxRetries);
067:
068: /** Return the time that the thread will sleep before looking up a proxy during fail over. */
069: long getRetryWaitingTimeMS();
070:
071: /** @see #getRetryWaitingTimeMS() */
072: void setRetryWaitingTimeMS(long retryWaitingTimeMS);
073:
074: /** Return the proxy, if it is cached then it will return the cached proxy otherwise it will perform a JNDI lookup. */
075: HASingletonInvoker.Proxy lookupProxy();
076:
077: /**
078: * Invoke the service through the invoker. When the service proxy throws an exception the invoker waits for a
079: * specific duration and then perform a new lookup for a certain amount of time.
080: */
081: Object invoke(String methodName, Class[] types, Object[] args)
082: throws Exception;
083:
084: /** Contract layer that defines the interactions between the service and the ha invoker. */
085: interface Callback {
086: /**
087: * Set the invoker on the client, if the invoker is not null then the invoker is available otherwise if it is null
088: * then the invoker is not available.
089: */
090: void setInvoker(HASingletonInvoker invoker);
091:
092: /** Start the singleton. */
093: void startSingleton();
094:
095: /** Stop the singleton. */
096: void stopSingleton();
097:
098: /** Invocation callback */
099: Object invoke(String methodName, Class[] types, Object[] args)
100: throws Exception;
101:
102: /** Provide a simple display name for logging purpose. */
103: String getDisplayName();
104: }
105:
106: /** The proxy interface bound in JNDI. */
107: interface Proxy {
108: Object invoke(String methodName, Class[] types, Object[] args)
109: throws Exception;
110: }
111: }
|