KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > invocation > http > server > HttpProxyFactoryMBean


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22 package org.jboss.invocation.http.server;
23
24 import javax.management.ObjectName JavaDoc;
25
26 import org.jboss.system.Service;
27
28 import org.w3c.dom.Element JavaDoc;
29
30 /** An mbean interface for a proxy factory that can expose any interface
31  * with RMI compatible semantics for access to remote clients using HTTP
32  * as the transport.
33  *
34  * @author Scott.Stark@jboss.org
35  * @version $Revision: 37459 $
36  */
37 public interface HttpProxyFactoryMBean extends Service
38 {
39    /** Get the server side mbean that exposes the invoke operation for the
40     exported interface */
41    public ObjectName JavaDoc getInvokerName();
42    /** Set the server side mbean that exposes the invoke operation for the
43     exported interface */
44    public void setInvokerName(ObjectName JavaDoc jmxInvokerName);
45
46    /** Get the JNDI name under which the HttpInvokerProxy will be bound */
47    public String JavaDoc getJndiName();
48    /** Set the JNDI name under which the HttpInvokerProxy will be bound */
49    public void setJndiName(String JavaDoc jndiName);
50
51    /** Get the http URL to the InvokerServlet */
52    public String JavaDoc getInvokerURL();
53    /** Set the http URL to the InvokerServlet */
54    public void setInvokerURL(String JavaDoc invokerURL);
55
56    /** If there is no invokerURL set, then one will be constructed via the
57     * concatenation of invokerURLPrefix + the local host + invokerURLSuffix.
58     */
59    public String JavaDoc getInvokerURLPrefix();
60    /** If there is no invokerURL set, then one will be constructed via the
61     * concatenation of invokerURLPrefix + the local host + invokerURLSuffix.
62     * An example prefix is "http://", and this is the default value.
63     */
64    public void setInvokerURLPrefix(String JavaDoc invokerURLPrefix);
65
66    /** If there is no invokerURL set, then one will be constructed via the
67     * concatenation of invokerURLPrefix + the local host + invokerURLSuffix.
68     */
69    public String JavaDoc getInvokerURLSuffix();
70    /** If there is no invokerURL set, then one will be constructed via the
71     * concatenation of invokerURLPrefix + the local host + invokerURLSuffix.
72     * An example suffix is "/invoker/JMXInvokerServlet" and this is the default
73     * value.
74     */
75    public void setInvokerURLSuffix(String JavaDoc invokerURLSuffix);
76
77    /** A flag if the InetAddress.getHostName() or getHostAddress() method
78     * should be used as the host component of invokerURLPrefix + host +
79     * invokerURLSuffix. If true getHostName() is used, false getHostAddress().
80     */
81    public boolean getUseHostName();
82    /** A flag if the InetAddress.getHostName() or getHostAddress() method
83     * should be used as the host component of invokerURLPrefix + host +
84     * invokerURLSuffix. If true getHostName() is used, false getHostAddress().
85     */
86    public void setUseHostName(boolean flag);
87
88    /** Get the RMI compatible interface that the HttpInvokerProxy implements */
89    public Class JavaDoc getExportedInterface();
90    /** Set the RMI compatible interface that the HttpInvokerProxy implements */
91    public void setExportedInterface(Class JavaDoc exportedInterface);
92
93    public Element JavaDoc getClientInterceptors();
94    public void setClientInterceptors(Element JavaDoc config) throws Exception JavaDoc;
95    /** Get the proxy instance created by the factory.
96     */
97    public Object JavaDoc getProxy();
98    /** Create a new proxy instance with the given id, no jndi name and all
99     * other settings the same as the jndi bound proxy.
100     */
101    public Object JavaDoc getProxy(Object JavaDoc id);
102 }
103
Popular Tags