KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > remoting > ServerInvokerMBean


1 package org.jboss.remoting;
2
3 import java.io.IOException JavaDoc;
4 import java.util.Map JavaDoc;
5
6 /**
7  * @author <a HREF="mailto:telrod@e2technologies.net">Tom Elrod</a>
8  */

9 public interface ServerInvokerMBean
10 {
11    /**
12     * Will get the data type for the marshaller factory so know which marshaller to
13     * get to marshal the data. Will first check the locator uri for a 'datatype'
14     * parameter and take that value if it exists. Otherwise, will use the
15     * default datatype for the client invoker, based on transport.
16     *
17     * @return
18     */

19    String JavaDoc getDataType();
20
21    /**
22     * returns true if the transport is bi-directional in nature, for example,
23     * SOAP in unidirectional and SOCKETs are bi-directional (unless behind a firewall
24     * for example).
25     *
26     * @return
27     */

28    boolean isTransportBiDirectional();
29
30    void create();
31
32    /**
33     * subclasses should override to provide any specific start logic
34     *
35     * @throws java.io.IOException
36     */

37    void start() throws IOException JavaDoc;
38
39    /**
40     * return true if the server invoker is started, false if not
41     *
42     * @return
43     */

44    boolean isStarted();
45
46    /**
47     * subclasses should override to provide any specific stop logic
48     */

49    void stop();
50
51    /**
52     * destory the invoker permanently
53     */

54    void destroy();
55
56    /**
57     * Sets the server invoker's transport specific configuration. Will need to set before calling
58     * start() method (or at least stop() and start() again) before configurations will take affect.
59     *
60     * @param configuration
61     */

62    void setConfigration(Map JavaDoc configuration);
63
64    /**
65     * Gets teh server invoker's transport specific configuration.
66     *
67     * @return
68     */

69    Map JavaDoc getConfiguration();
70
71    /**
72     * @jmx:managed-attribute
73     */

74    String JavaDoc getClientConnectAddress();
75
76    int getClientConnectPort();
77
78    /**
79     * This method should only be called by the service controller when this invoker is
80     * specified within the Connector configuration of a service xml. Calling this directly
81     * will have no effect, as will be used in building the locator uri that is published
82     * for detection and this happens when the invoker is first created and started (after that, no one
83     * will be aware of a change).
84     *
85     * @jmx:managed-attribute
86     */

87    void setClientConnectAddress(String JavaDoc clientConnectAddress);
88
89    String JavaDoc getServerBindAddress();
90
91    int getServerBindPort();
92
93    void setClientConnectPort(int clientConnectPort);
94 }
95
Popular Tags