KickJava   Java API By Example, From Geeks To Geeks.

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


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 java.net.URL JavaDoc;
25
26 import org.jboss.invocation.Invocation;
27 import org.jboss.system.ServiceMBean;
28
29 /** The MBean interface for the HTTP invoker.
30  @author Scott.Stark@jboss.org
31  @version $Revision: 37459 $
32  */

33 public interface HttpInvokerMBean extends ServiceMBean
34 {
35    /** Get the URL string of the servlet that will handle posts from
36     * the HttpInvokerProxy
37     */

38    public String JavaDoc getInvokerURL();
39    /** Get the URL string of the servlet that will handle posts from
40     * the HttpInvokerProxy. For example, http://webhost:8080/invoker/JMXInvokerServlet
41     */

42    public void setInvokerURL(String JavaDoc invokerURL);
43
44    /** If there is no invokerURL set, then one will be constructed via the
45     * concatenation of invokerURLPrefix + the local host + invokerURLSuffix.
46     */

47    public String JavaDoc getInvokerURLPrefix();
48    /** If there is no invokerURL set, then one will be constructed via the
49     * concatenation of invokerURLPrefix + the local host + invokerURLSuffix.
50     * An example prefix is "http://", and this is the default value.
51     */

52    public void setInvokerURLPrefix(String JavaDoc invokerURLPrefix);
53
54    /** If there is no invokerURL set, then one will be constructed via the
55     * concatenation of invokerURLPrefix + the local host + invokerURLSuffix.
56     */

57    public String JavaDoc getInvokerURLSuffix();
58    /** If there is no invokerURL set, then one will be constructed via the
59     * concatenation of invokerURLPrefix + the local host + invokerURLSuffix.
60     * An example suffix is "/invoker/JMXInvokerServlet" and this is the default
61     * value.
62     */

63    public void setInvokerURLSuffix(String JavaDoc invokerURLSuffix);
64
65    /** A flag if the InetAddress.getHostName() or getHostAddress() method
66     * should be used as the host component of invokerURLPrefix + host +
67     * invokerURLSuffix. If true getHostName() is used, false getHostAddress().
68     */

69    public boolean getUseHostName();
70    /** A flag if the InetAddress.getHostName() or getHostAddress() method
71     * should be used as the host component of invokerURLPrefix + host +
72     * invokerURLSuffix. If true getHostName() is used, false getHostAddress().
73     */

74    public void setUseHostName(boolean flag);
75
76    /** The invoker JMX method
77    */

78    public Object JavaDoc invoke(Invocation invocation)
79       throws Exception JavaDoc;
80 }
81
Popular Tags