/*
* JBoss, Home of Professional Open Source
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags.
* See the copyright.txt in the distribution for a full listing
* of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* (C) 2005-2006,
* @author JBoss Inc.
*/
/*
* Copyright (C) 2002,
*
* Arjuna Technologies Limited,
* Newcastle upon Tyne,
* Tyne and Wear,
* UK.
*
* $Id: ProtocolManager.java,v 1.13 2005/05/19 12:13:28 nmcl Exp $
*/
package com.arjuna.mw.wscf11.protocols;
import com.arjuna.mw.wscf11.common.Environment;
import com.arjuna.mw.wscf.exceptions.ProtocolAlreadyRegisteredException;
import com.arjuna.mw.wscf.exceptions.ProtocolNotRegisteredException;
import com.arjuna.mw.wscf.exceptions.UnknownProtocolImplementationException;
import com.arjuna.mw.wscf.logging.wscfLogger;
import com.arjuna.mw.wscf.utils.CoordinationXML;
import com.arjuna.mwlabs.wscf11.protocols.Initializer;
import com.arjuna.mwlabs.wscf.protocols.ProtocolEntry;
import com.arjuna.mwlabs.wscf.utils.ProtocolLocator;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Properties;
import java.util.Vector;
/**
* The ProtocolManager is the way in which protocol implementations may be
* registered with the system.
*
* @author Mark Little (mark.little@arjuna.com)
* @version $Id:$
* @since 1.0.
*/
public class ProtocolManager
{
/**
* Add a specific protocol implementation to the factory. More than one
* implementation may provide the same protocol. They may differ by
* coordinator-name only.
*
* @param protocol The XML definition of the protocol.
* @param className The name of the class that implements the specified
* protocol.
*
* @exception com.arjuna.mw.wscf.exceptions.ProtocolAlreadyRegisteredException
* Thrown if the exact same protocol definition has already
* been registered.
* @exception IllegalArgumentException
* Thrown if either of the parameters is invalid.
*/
public void addProtocol (org.w3c.dom.Document protocol, Object className)
throws ProtocolAlreadyRegisteredException,
IllegalArgumentException
{
if ((protocol == null) || (className == null))
throw new IllegalArgumentException();
if (present(protocol))
throw new ProtocolAlreadyRegisteredException();
else
{
ProtocolEntry e = new ProtocolEntry(protocol, className);
Vector impls = (Vector) _protocols.get(e.protocolType());
if (impls == null)
{
impls = new Vector();
_protocols.put(e.protocolType(), impls);
}
impls.add(e);
}
}
/**
* Replace a specific protocol implementation in the factory.
*
* @param protocol The XML definition of the protocol.
* @param className The name of the class that implements the specified
* protocol.
*
* @exception com.arjuna.mw.wscf.exceptions.ProtocolNotRegisteredException
* Thrown if the protocol to be removed has not been
* registered.
* @exception IllegalArgumentException
* Thrown if either of the parameters is invalid.
*/
public void replaceProtocol (org.w3c.dom.Document protocol, Object className)
throws ProtocolNotRegisteredException, IllegalArgumentException
{
synchronized (this)
{
CoordinationXML protocolDef = new CoordinationXML(protocol);
Vector impls = (Vector) _protocols.get(protocolDef.protocolType());
boolean found = false;
if (impls != null)
{
for (int i = 0; (i < impls.size()) && !found; i++)
{
ProtocolEntry entry = (ProtocolEntry) impls.elementAt(i);
// currently replaces only on type: should be exact match!
if (sameProtocolType(entry, protocolDef))
{
impls.remove(entry);
try
{
addProtocol(protocol, className);
}
catch (Exception ex)
{
throw new IllegalArgumentException(ex.toString());
}
found = true;
}
}
}
if (!found)
throw new ProtocolNotRegisteredException();
}
}
/**
* @param protocol The XML definition of the coordination protocol.
*
* @exception com.arjuna.mw.wscf.exceptions.ProtocolNotRegisteredException
* Thrown if the requested coordination protocol has not been
* registered.
* @exception IllegalArgumentException
* Thrown if the parameter is invalid.
*
* @return The class that implements the specified coordination protocol.
*
* @message com.arjuna.mw.wscf11.protocols.ProtocolManager_1
* [com.arjuna.mw.wscf11.protocols.ProtocolManager_1] - Could not
* find protocol:
*/
public Object getProtocolImplementation (org.w3c.dom.Document protocol)
throws ProtocolNotRegisteredException, IllegalArgumentException
{
/*
* Only checks the coordination-type via the hashtable. Now we need to
* check the coordination-name.
*/
CoordinationXML protocolDef = new CoordinationXML(protocol);
Vector impls = (Vector) _protocols.get(protocolDef.protocolType());
if (impls != null)
{
for (int i = 0; i < impls.size(); i++)
{
ProtocolEntry entry = (ProtocolEntry) impls.elementAt(i);
if (sameProtocolType(entry, protocolDef))
{
return entry.implementationClass();
}
}
}
throw new ProtocolNotRegisteredException(
wscfLogger.log_mesg.getString("com.arjuna.mw.wscf11.protocols.ProtocolManager_1")
+ protocolDef.protocolType());
}
/**
* Remove the specified protocol definition from the factory.
*
* @param protocol The XML definition of the coordination protocol.
*
* @exception com.arjuna.mw.wscf.exceptions.ProtocolNotRegisteredException
* Thrown if the protocol to be removed has not been
* registered.
* @exception IllegalArgumentException
* Thrown if the paramater is invalid (e.g., null).
*
* @return the protocol implementation removed.
*/
public Object removeProtocol (org.w3c.dom.Document protocol)
throws ProtocolNotRegisteredException, IllegalArgumentException
{
CoordinationXML protocolDef = new CoordinationXML(protocol);
Vector impls = (Vector) _protocols.get(protocolDef.protocolType());
if (impls != null)
{
for (int i = 0; i < impls.size(); i++)
{
ProtocolEntry entry = (ProtocolEntry) impls.elementAt(i);
if (sameProtocol(entry, protocolDef))
{
impls.remove(entry);
return entry.implementationClass();
}
}
}
throw new ProtocolNotRegisteredException();
}
/*
* Do we need this?
*/
/**
* Remove the specified coordination protocol implementation class from the
* factory.
*
* @param className The class to remove.
*
* @exception com.arjuna.mw.wscf.exceptions.UnknownProtocolImplementationException
* Thrown if the specified implementation class has not been
* registered.
* @exception IllegalArgumentException
* Thrown if the parameter is invalid.
*
* @return the protocol implementation removed.
*/
public Object removeProtocolImplementation (Object className)
throws UnknownProtocolImplementationException,
IllegalArgumentException
{
throw new UnknownProtocolImplementationException();
}
/**
* Is the document present exactly as it appears, i.e., even the name is the
* same?
*
* @param protocol The XML definition of the coordination protocol.
*
* @exception IllegalArgumentException
* Thrown if the parameter is invalid (e.g., null).
*
* @return <code>true</code> if there is an exact match for the specified
* protocol, <code>false</code> otherwise.
*/
public final boolean present (org.w3c.dom.Document protocol)
throws IllegalArgumentException
{
/*
* Only checks the coordination-type via the hashtable. Now we need to
* check the coordination-name.
*/
boolean found = false;
CoordinationXML protocolDef = new CoordinationXML(protocol);
Vector impls = (Vector) _protocols.get(protocolDef.protocolType());
if (impls != null)
{
for (int i = 0; (i < impls.size()) && !found; i++)
{
ProtocolEntry entry = (ProtocolEntry) impls.elementAt(i);
if (sameProtocolType(entry, protocolDef))
found = true;
}
}
return found;
}
/**
* Is the document present but with a different name?
*
* @param protocol The XML definition of the coordination protocol.
*
* @exception IllegalArgumentException
* Thrown if the parameter is invalid (e.g., null).
*
* @return <code>true</code> if there is at match for the specified
* protocol, <code>false</code> otherwise.
*/
public final boolean presentWithDifferentName (org.w3c.dom.Document protocol)
throws IllegalArgumentException
{
/*
* Check the registered protocols and if the types are the same but
* differ by name (essentially who implemented them) then they are not
* identical.
*/
boolean found = false;
CoordinationXML protocolDef = new CoordinationXML(protocol);
Vector impls = (Vector) _protocols.get(protocolDef.protocolType());
if (impls != null)
{
if (protocolDef.protocolName() != null)
{
for (int i = 0; (i < impls.size()) && !found; i++)
{
ProtocolEntry entry = (ProtocolEntry) impls.elementAt(i);
if (sameProtocol(entry, protocolDef))
found = true;
}
}
else
found = true; // any will do
}
return found;
}
protected ProtocolManager()
{
initialise();
}
private final boolean sameProtocolType (ProtocolEntry pe, CoordinationXML cx)
{
if (pe.protocolType() != null)
{
if (cx.protocolType() != null)
{
return cx.protocolType().equals(pe.protocolType());
}
}
return false;
}
private final boolean sameProtocol (ProtocolEntry pe, CoordinationXML cx)
{
if (sameProtocolType(pe, cx))
{
if (pe.protocolName() != null)
{
if (cx.protocolName() != null)
return cx.protocolName().equals(pe.protocolName());
}
}
return false;
}
/**
* @message com.arjuna.mw.wscf11.protocols.ProtocolManager_2
* [com.arjuna.mw.wscf11.protocols.ProtocolManager_2] - Failed to
* find document:
*/
private synchronized final void initialise ()
{
if (_initialised)
return;
else
_initialised = true;
// TODO sort out configuration!
try
{
Initializer init = new Initializer(this);
}
catch (Exception ex)
{
ex.printStackTrace();
}
Properties props = System.getProperties();
Enumeration names = props.propertyNames();
while (names.hasMoreElements())
{
String name = (String) names.nextElement();
if (name.startsWith(Environment.PROTOCOL_IMPLEMENTATION))
{
String className = props.getProperty(name);
try
{
Class clazz = this.getClass().getClassLoader().loadClass(className);
ProtocolLocator pl = new ProtocolLocator(clazz);
org.w3c.dom.Document doc = pl.getProtocol();
if (doc == null)
{
// TODO
throw new ExceptionInInitializerError(
wscfLogger.log_mesg.getString("com.arjuna.mw.wscf11.protocols.ProtocolManager_2")
+ className);
}
else
{
addProtocol(doc, className);
}
}
catch (Exception ex)
{
ex.printStackTrace();
throw new ExceptionInInitializerError(ex.toString());
}
}
}
}
private HashMap _protocols = new HashMap();
private boolean _initialised = false;
}