/*
* JacORB - a free Java ORB
*
* Copyright (C) 2000-2014 Gerald Brose / The JacORB Team.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
package org.jacorb.orb;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.jacorb.config.Configurable;
import org.jacorb.config.Configuration;
import org.jacorb.config.ConfigurationException;
import org.jacorb.orb.etf.ListenEndpoint;
import org.jacorb.orb.etf.ListenEndpoint.Protocol;
import org.jacorb.orb.etf.ListenerBase;
import org.jacorb.orb.giop.GIOPConnection;
import org.jacorb.orb.giop.GIOPConnectionManager;
import org.jacorb.orb.giop.MessageReceptorPool;
import org.jacorb.orb.giop.NoBiDirServerReplyListener;
import org.jacorb.orb.giop.ReplyListener;
import org.jacorb.orb.giop.RequestListener;
import org.jacorb.orb.giop.ServerRequestListener;
import org.jacorb.orb.giop.TransportManager;
import org.jacorb.orb.iiop.IIOPAddress;
import org.jacorb.orb.iiop.IIOPListener;
import org.jacorb.orb.iiop.IIOPProfile;
import org.omg.CORBA.CompletionStatus;
import org.omg.CORBA.INTERNAL;
import org.omg.CORBA.OMGVMCID;
import org.omg.ETF.Connection;
import org.omg.ETF.Factories;
import org.omg.ETF.Listener;
import org.omg.ETF.Profile;
import org.slf4j.Logger;
/**
* Class BasicAdapter, used by the POA.
*
* @author Gerald Brose
*/
public class BasicAdapter
extends org.omg.ETF._HandleLocalBase
implements Configurable
{
private final List<Listener> listeners = new ArrayList<Listener>();
private MessageReceptorPool receptor_pool = null;
private final ServerRequestListener request_listener;
private ReplyListener reply_listener = null;
private final TransportManager transport_manager;
private final GIOPConnectionManager giop_connection_manager;
/** the configuration object */
private org.jacorb.config.Configuration configuration = null;
private Logger logger = null;
private final ORB orb;
BasicAdapter( org.jacorb.orb.ORB orb,
org.jacorb.poa.POA poa, TransportManager transport_manager, GIOPConnectionManager giop_connection_manager )
{
super();
this.orb = orb;
this.transport_manager = transport_manager;
this.giop_connection_manager = giop_connection_manager;
request_listener = new ServerRequestListener(orb, poa);
}
/**
* configure the BasicAdapter
*/
@Override
public void configure(Configuration myConfiguration)
throws ConfigurationException
{
configuration = myConfiguration;
logger = configuration.getLogger("org.jacorb.orb.basic");
receptor_pool = new MessageReceptorPool("server", "ServerMessageReceptor", myConfiguration);
request_listener.configure( configuration );
reply_listener = new NoBiDirServerReplyListener();
// create all Listeners
for (Iterator<Factories> i = getListenerFactories().iterator(); i.hasNext();)
{
Factories factories = i.next();
Protocol p = Protocol.mapProfileTag(factories.profile_tag());
Iterator<ListenEndpoint> it = transport_manager.getListenEndpoints(p).iterator();
while (it.hasNext())
{
Listener listener = factories.create_listener (null, (short)0, (short)0);
ListenEndpoint le = it.next();
if (listener instanceof ListenerBase)
{
((ListenerBase)listener).setListenEndpoint(le);
}
if (listener instanceof Configurable)
{
((Configurable)listener).configure(configuration);
}
listener.set_handle(this);
listeners.add (listener);
}
}
// activate them
for (Iterator<Listener> i = listeners.iterator(); i.hasNext();)
{
i.next().listen();
}
}
/**
* Returns a List of Factories for all transport plugins that
* should listen for incoming connections.
*/
private List<Factories> getListenerFactories()
{
List<Factories> result = new ArrayList<Factories>();
List<String> tags = configuration.getAttributeList("jacorb.transport.server.listeners");
if (tags.isEmpty())
{
result.addAll(transport_manager.getFactoriesList());
}
else
{
if (tags.contains("off"))
{
tags.remove("off");
}
for (Iterator<String> i = tags.iterator(); i.hasNext();)
{
String s = i.next();
int tag = -1;
try
{
tag = Integer.parseInt(s);
}
catch (NumberFormatException ex)
{
throw new IllegalArgumentException
("could not parse profile tag for listener: " + s
+ " (should have been a number)");
}
Factories factories = transport_manager.getFactories (tag);
if (factories == null)
{
throw new IllegalArgumentException
("could not find Factories for profile tag: " + tag);
}
result.add(factories);
}
}
return result;
}
public RequestListener getRequestListener()
{
return request_listener;
}
/**
* Returns a List of endpoint profiles for all transports that listen
* for incoming connections. Each individual profile is a copy and can
* safely be modified by the caller (e.g. add an object key, patch the
* address, stuff it into an IOR, etc.).
*/
public List<Profile> getEndpointProfiles()
{
List<Profile> result = new ArrayList<Profile>();
for (Iterator<Listener> i = listeners.iterator(); i.hasNext();)
{
Listener listener = i.next();
result.add(listener.endpoint());
}
return result;
}
/**
* If only a single IIOPListener (and no other Listener) is
* active for this BasicAdapter, then this method returns it.
* Otherwise it returns null.
*/
private IIOPListener getIIOPListener()
{
if (listeners.size() == 1)
{
Listener listener = listeners.get(0);
if (listener instanceof IIOPListener)
{
return (IIOPListener)listener;
}
return null;
}
return null;
}
/**
* @deprecated This method cannot return a sensible result in the presence
* of alternate transports, use {@link #getEndpointProfiles()} instead.
*/
@Deprecated
public int getPort()
{
IIOPListener l = getIIOPListener();
if (l != null)
{
IIOPProfile profile = (IIOPProfile)l.endpoint();
return ((IIOPAddress)profile.getAddress()).getPort();
}
throw new RuntimeException("Cannot find server port for non-IIOP transport");
}
/**
* @deprecated This method cannot return a sensible result in the presence
* of alternate transports, use {@link #getEndpointProfiles()} instead.
*/
@Deprecated
public int getSSLPort()
{
IIOPListener listener = getIIOPListener();
if (listener != null)
{
return ((IIOPProfile)listener.endpoint()).getSSLPort();
}
throw new RuntimeException("Non-IIOP transport does not have an SSL port");
}
/**
* @deprecated This method cannot return a sensible result in the presence
* of alternate transports, use {@link #getEndpointProfiles()} instead.
*/
@Deprecated
public boolean hasSSLListener()
{
return getSSLPort() != -1;
}
/**
* @deprecated This method cannot return a sensible result in the presence
* of alternate transports, use {@link #getEndpointProfiles()} instead.
*/
@Deprecated
public String getAddress()
{
IIOPListener l = getIIOPListener();
if (l != null)
{
IIOPProfile profile = (IIOPProfile)l.endpoint();
return ((IIOPAddress)profile.getAddress()).getHostName();
}
throw new RuntimeException("Cannot find server address for non-IIOP transport");
}
/**
* to be called from the POA, code duplicated for performance
* reasons to avoid synchronization in the private version of this
* method.
*/
public void deliverRequest( org.jacorb.orb.dsi.ServerRequest request,
org.omg.PortableServer.POA poa )
{
org.jacorb.poa.POA tmp_poa = (org.jacorb.poa.POA)poa;
String scopes[] = request.remainingPOAName();
try
{
for( int i=0; i < scopes.length; i++)
{
if( scopes[i].equals(""))
{
break;
}
try
{
tmp_poa = tmp_poa._getChildPOA( scopes[i] );
}
catch ( org.jacorb.poa.except.ParentIsHolding p )
{
/*
* if one of the POAs is in holding state, we
* simply deliver the request to this
* POA. It will forward the request to its child
* POAs if necessary when changing back to active
* For the POA to be able to forward this request
* to its child POAa, we need to supply the
* remaining part of the child's POA name
*/
String[] rest_of_name = new String[scopes.length - i];
for( int j = 0; j < rest_of_name.length; j++ )
{
rest_of_name[j] = scopes[j+i];
}
request.setRemainingPOAName(rest_of_name);
break;
}
}
if( tmp_poa == null )
{
throw new INTERNAL("Request POA null!");
}
/* hand over to the POA */
tmp_poa._invoke( request );
}
catch( org.omg.PortableServer.POAPackage.WrongAdapter e )
{
// unknown oid (not previously generated)
request.setSystemException( new org.omg.CORBA.OBJECT_NOT_EXIST("unknown oid",
OMGVMCID.value | 2,
CompletionStatus.COMPLETED_NO) );
request.reply();
}
catch( org.omg.CORBA.SystemException e )
{
request.setSystemException( e );
request.reply();
}
catch (RuntimeException e)
{
request.setSystemException( new org.omg.CORBA.UNKNOWN( e.toString()) );
request.reply();
logger.warn("unexpected exception", e);
}
catch( Throwable e )
{
// TODO in general its not advisable
// to catch Throwable as this also includes
// Errors (e.g. OutOfMemoryError)
// TODO throw exception?
request.setSystemException( new org.omg.CORBA.UNKNOWN( e.toString()) );
request.reply();
logger.error("unexpected exception", e);
}
}
/**
* to be called from the POA
*/
public void return_result(org.jacorb.orb.dsi.ServerRequest request)
{
request.reply();
}
public void stopListeners()
{
for (Iterator<Listener> i = listeners.iterator(); i.hasNext();)
{
i.next().destroy();
}
receptor_pool.shutdown();
}
/**
* Tell all IIOPListeners to renew their SSL server sockets.
*
* @see IIOPListener#renewSSLServerSocket
*/
public void renewSSLServerSockets()
{
for (Iterator<Listener> i = listeners.iterator(); i.hasNext();)
{
Object o = i.next();
if (o instanceof IIOPListener)
{
((IIOPListener) o).renewSSLServerSocket();
}
}
}
// Handle methods below this line
/**
* Announces a new connection instance to the ORB.
* The caller shall examine the boolean return value and
* destroy the connection, if the call returns false.
* A new connection initially belongs to the plug-in,
* and it shall signal the connection to the ORB when
* the first incoming request data was received,
* using this Handle upcall.
* <p>
* The Handle shall accept the connection (and cache
* information about it if needed), as long as it is
* allowed to do so by the ORB. In this case it shall
* return true. If a new connection is currently not
* allowed, it shall ignore the passed instance and
* return false.
*/
@Override
public boolean add_input (org.omg.ETF.Connection conn)
{
GIOPConnection giopConnection =
giop_connection_manager.createServerGIOPConnection
(
conn.get_server_profile(),
conn,
request_listener,
reply_listener
);
if ( giopConnection == null )
{
return false;
}
else
{
receptor_pool.connectionCreated( giopConnection );
return true;
}
}
/**
* In some cases, the client side can initiate the closing of a
* connection. The plugin shall signal this event to the server side
* ORB via its Handle by calling this function.
*/
@Override
public void closed_by_peer (org.omg.ETF.Connection conn)
{
// We don't do this in JacORB; Connections are never
// given back to the Listener after they have been
// passed up initially.
throw new org.omg.CORBA.NO_IMPLEMENT();
}
/**
* The plugged-in transport (e.g. the Listener instance) shall call
* this function when it owns a server-side Connection and data arrives
* on the local endpoint. This will start a new request dispatching
* cycle in the ORB. Subsequently, it shall ignore any other incoming
* data from this Connection until the Listener's completed_data function
* is called by the ORB.
*/
@Override
public void signal_data_available (Connection conn)
{
// We don't do this in JacORB; Connections are never
// given back to the Listener after they have been
// passed up initially.
throw new org.omg.CORBA.NO_IMPLEMENT();
}
public ORB getORB()
{
return orb;
}
}