← Back to branch summary

~ubuntu-branches/ubuntu/raring/libjboss-remoting-java/raring

« back to all changes in this revision

Viewing changes to src/main/org/jboss/remoting/ServerInvokerMBean.java

  • Committer: Package Import Robot
  • Author(s): Torsten Werner
  • Date: 2011-09-09 14:01:03 UTC
  • mto: This revision was merged to the branch mainline in revision 9.
  • Revision ID: package-import@ubuntu.com-20110909140103-o8ucrolqt5g25k57
Tags: upstream-2.5.3.SP1
Import upstream version 2.5.3.SP1

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/main/org/jboss/remoting/ServerInvokerMBean.java
 
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.remoting;
 
23
 
 
24
import java.io.IOException;
 
25
import java.util.Map;
 
26
 
 
27
/**
 
28
 * @author <a href="mailto:telrod@e2technologies.net">Tom Elrod</a>
 
29
 */
 
30
public interface ServerInvokerMBean
 
31
{
 
32
   /**
 
33
    * Will get the data type for the marshaller factory so know which marshaller to
 
34
    * get to marshal the data.  Will first check the locator uri for a 'datatype'
 
35
    * parameter and take that value if it exists.  Otherwise, will use the
 
36
    * default datatype for the client invoker, based on transport.
 
37
    *
 
38
    * @return
 
39
    */
 
40
   String getDataType();
 
41
 
 
42
   /**
 
43
    * returns true if the transport is bi-directional in nature, for example,
 
44
    * SOAP in unidirectional and SOCKETs are bi-directional (unless behind a firewall
 
45
    * for example).
 
46
    *
 
47
    * @return
 
48
    */
 
49
   boolean isTransportBiDirectional();
 
50
 
 
51
   void create();
 
52
 
 
53
   /**
 
54
    * subclasses should override to provide any specific start logic
 
55
    *
 
56
    * @throws java.io.IOException
 
57
    */
 
58
   void start() throws IOException;
 
59
 
 
60
   /**
 
61
    * return true if the server invoker is started, false if not
 
62
    *
 
63
    * @return
 
64
    */
 
65
   boolean isStarted();
 
66
 
 
67
   /**
 
68
    * subclasses should override to provide any specific stop logic
 
69
    */
 
70
   void stop();
 
71
 
 
72
   /**
 
73
    * destory the invoker permanently
 
74
    */
 
75
   void destroy();
 
76
 
 
77
   /**
 
78
    * Sets the server invoker's transport specific configuration.  Will need to set before calling
 
79
    * start() method (or at least stop() and start() again) before configurations will take affect.
 
80
    *
 
81
    * @param configuration
 
82
    */
 
83
   void setConfiguration(Map configuration);
 
84
 
 
85
   /**
 
86
    * Gets teh server invoker's transport specific configuration.
 
87
    *
 
88
    * @return
 
89
    */
 
90
   Map getConfiguration();
 
91
 
 
92
   /**
 
93
    * @jmx:managed-attribute
 
94
    */
 
95
   String getClientConnectAddress();
 
96
 
 
97
   int getClientConnectPort();
 
98
 
 
99
   /**
 
100
    * This method should only be called by the service controller when this invoker is
 
101
    * specified within the Connector configuration of a service xml.  Calling this directly
 
102
    * will have no effect, as will be used in building the locator uri that is published
 
103
    * for detection and this happens when the invoker is first created and started (after that, no one
 
104
    * will be aware of a change).
 
105
    *
 
106
    * @jmx:managed-attribute
 
107
    */
 
108
   void setClientConnectAddress(String clientConnectAddress);
 
109
 
 
110
   String getServerBindAddress();
 
111
 
 
112
   int getServerBindPort();
 
113
 
 
114
   void setClientConnectPort(int clientConnectPort);
 
115
 
 
116
   void setTimeout(int timeout);
 
117
 
 
118
   int getTimeout();
 
119
}