01: /*
02: * <copyright>
03: *
04: * Copyright 2003-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.core.service;
28:
29: import java.util.Map;
30:
31: import org.cougaar.core.component.Service;
32:
33: /**
34: * This service is used to get a socket factory, such as an {@link
35: * java.rmi.server.RMISocketFactory}.
36: */
37: public interface SocketFactoryService extends Service {
38: /**
39: * Get an appropriate SocketFactory instance.
40: * the return value is typed Object because RMISocketFactory and SSLSocketFactory
41: * do not otherwise share a superclass.
42: * Implementations will generally support SSLSocketFactory, SSLServerSocketFactory, and RMISocketFactory.
43: * RMISocketFactory may be parameterized (via the second argument) with "ssl"=Boolean (default FALSE) and
44: * "aspects"=Boolean (default FALSE).
45: * <p>
46: * Example:<br>
47: * <code>
48: * Map params = new HashMap(); params.put("ssl", Boolean.TRUE);<br>
49: * RMISocketFactory rsf = (RMISocketFactory) socketFactoryService.getSocketFactory(RMISocketFactory.class, params);<br>
50: * </code>
51: * @param clazz Specifies the class required. If the class cannot be supported by
52: * the service, it will return null.
53: * @param m Allows arbitrary preferences and parameters to be specified.
54: * @return an object which is instanceof the requested class or null.
55: */
56: Object getSocketFactory(Class clazz, Map m);
57: }
|