Connection (GlassFish Corba ORB 4.2.1 API)

All Superinterfaces:: Connection

public interface Connection
extends Connection

Author:: Harold Carr

Field Summary

Fields
Modifier and Type Field and Description

static int ABORT

static int CLOSE_RECVD

static int CLOSE_SENT

static int ESTABLISHED

static int OPENING

Fields
Modifier and Type	Field and Description
`static int`	`ABORT`
`static int`	`CLOSE_RECVD`
`static int`	`CLOSE_SENT`
`static int`	`ESTABLISHED`
`static int`	`OPENING`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`MessageMediator`	`clientReply_1_1_Get()`
`void`	`clientReply_1_1_Put(MessageMediator x)`
`void`	`clientReply_1_1_Remove()`
`MessageMediator`	`clientRequestMapGet(int requestId)`
`void`	`close()`
`void`	`closeConnectionResources()` Clean up all connection resources.
`Acceptor`	`getAcceptor()`
`ORB`	`getBroker()`
`CodeBase`	`getCodeBase()`
`IOR`	`getCodeBaseIOR()`
`CodeSetComponentInfo.CodeSetContext`	`getCodeSetContext()`
`ConnectionCache`	`getConnectionCache()`
`ContactInfo`	`getContactInfo()`
`EventHandler`	`getEventHandler()`
`Queue<MessageMediator>`	`getFragmentList(RequestId corbaRequestId)`
`int`	`getNextRequestId()`
`ResponseWaitingRoom`	`getResponseWaitingRoom()`
`SocketChannel`	`getSocketChannel()`
`long`	`getTimeStamp()` Timestamps are used for connection management, in particular, for reclaiming idle `Connection`s.
`boolean`	`hasSocketChannel()`
`boolean`	`isBusy()` Indicates if the `Connection` is in the process of sending or receiving a message.
`boolean`	`isClosed()` Indicates if the `Connection` is closed.
`boolean`	`isPostInitialContexts()`
`boolean`	`isServer()` Indicates whether a CorbaContactInfo or CorbaAcceptor created the `Connection`.
`void`	`purgeCalls(SystemException systemException, boolean die, boolean lockHeld)`
`boolean`	`read()` Called to read incoming messages.
`void`	`registerWaiter(MessageMediator messageMediator)` Register an invocation's CorbaMessageMediator with the `Connection`.
`void`	`removeFragmentList(RequestId corbaRequestId)`
`void`	`sendCancelRequest(GIOPVersion giopVersion, int requestId)`
`void`	`sendCancelRequestWithLock(GIOPVersion giopVersion, int requestId)`
`void`	`sendCloseConnection(GIOPVersion giopVersion)`
`void`	`sendMessageError(GIOPVersion giopVersion)`
`void`	`sendWithoutLock(CDROutputObject outputObject)`
`MessageMediator`	`serverRequest_1_1_Get()`
`void`	`serverRequest_1_1_Put(MessageMediator x)`
`void`	`serverRequest_1_1_Remove()`
`MessageMediator`	`serverRequestMapGet(int requestId)`
`void`	`serverRequestMapPut(int requestId, MessageMediator messageMediator)`
`void`	`serverRequestMapRemove(int requestId)`
`void`	`serverRequestProcessingBegins()`
`void`	`serverRequestProcessingEnds()`
`void`	`setCodeBaseIOR(IOR ior)`
`void`	`setCodeSetContext(CodeSetComponentInfo.CodeSetContext csc)`
`void`	`setConnectionCache(ConnectionCache connectionCache)`
`void`	`setPostInitialContexts()`
`void`	`setState(String state)` The "state" of the `Connection`.
`void`	`setTimeStamp(long time)` Timestamps are used for connection management, in particular, for reclaiming idle `Connection`s.
`boolean`	`shouldRegisterReadEvent()` Used to determine if the `Connection` should register with the CorbaTransportManager Selector to handle read events.
`boolean`	`shouldRegisterServerReadEvent()` Used to determine if the `Connection` should register with the CorbaTransportManager Selector to handle read events.
`void`	`unregisterWaiter(MessageMediator messageMediator)` Unregister an invocation's * CorbaMessageMediator with the `Connection`.
`CDRInputObject`	`waitForResponse(MessageMediator messageMediator)` If a message expect's a response then this method is called.
`void`	`write(ByteBuffer byteBuffer)`
`void`	`writeLock()` Grab a write lock on the `Connection`.
`void`	`writeUnlock()` Release a write lock on the `Connection`.

Methods inherited from interface com.sun.corba.ee.spi.legacy.connection.Connection
getSocket

- Field Detail
  - OPENING
```
static final int OPENING
```
    See Also:
    
    Constant Field Values
  - ESTABLISHED
```
static final int ESTABLISHED
```
    See Also:
    
    Constant Field Values
  - CLOSE_SENT
```
static final int CLOSE_SENT
```
    See Also:
    
    Constant Field Values
  - CLOSE_RECVD
```
static final int CLOSE_RECVD
```
    See Also:
    
    Constant Field Values
  - ABORT
```
static final int ABORT
```
    See Also:
    
    Constant Field Values
- Method Detail
  - shouldRegisterReadEvent
```
boolean shouldRegisterReadEvent()
```
    Used to determine if the Connection should register with the CorbaTransportManager Selector to handle read events. For example, an HTTP transport would not register since the requesting thread would just block on read when waiting for the reply.
    
    Returns:
    
    true if it should be registered.
  - shouldRegisterServerReadEvent
```
boolean shouldRegisterServerReadEvent()
```
    Used to determine if the Connection should register with the CorbaTransportManager Selector to handle read events. For example, an HTTP transport would not register since the requesting thread would just block on read when waiting for the reply.
    
    Returns:
    
    true if it should be registered.
  - read
```
boolean read()
```
    Called to read incoming messages.
    
    Returns:
    
    true if the thread calling read can be released.
  - close
```
void close()
```
  - getAcceptor
```
Acceptor getAcceptor()
```
  - getContactInfo
```
ContactInfo getContactInfo()
```
  - getEventHandler
```
EventHandler getEventHandler()
```
  - isServer
```
boolean isServer()
```
    Indicates whether a CorbaContactInfo or CorbaAcceptor created the Connection.
    
    Returns:
    
    true if a CorbaAcceptor created the Connection.
  - isClosed
```
boolean isClosed()
```
    Indicates if the Connection is closed.
    
    Returns:
    
    true if the Connection is closed.
  - isBusy
```
boolean isBusy()
```
    Indicates if the Connection is in the process of sending or receiving a message.
    
    Returns:
    
    true if the Connection is busy.
  - getTimeStamp
```
long getTimeStamp()
```
    Timestamps are used for connection management, in particular, for reclaiming idle Connections.
    
    Returns:
    
    the "time" the Connection was last used.
  - setTimeStamp
```
void setTimeStamp(long time)
```
    Timestamps are used for connection management, in particular, for reclaiming idle Connections.
    
    Parameters:
    
    time - - the "time" the Connection was last used.
  - setState
```
void setState(String state)
```
    The "state" of the Connection. param state
  - writeLock
```
void writeLock()
```
    Grab a write lock on the Connection. If another thread already has a write lock then the calling thread will block until the lock is released. The calling thread must call writeUnlock() when it is done.
  - writeUnlock
```
void writeUnlock()
```
    Release a write lock on the Connection.
  - sendWithoutLock
```
void sendWithoutLock(CDROutputObject outputObject)
```
  - registerWaiter
```
void registerWaiter(MessageMediator messageMediator)
```
    Register an invocation's CorbaMessageMediator with the Connection. This is useful in protocols which support fragmentation.
    
    Parameters:
    
    messageMediator -
  - waitForResponse
```
CDRInputObject waitForResponse(MessageMediator messageMediator)
```
    If a message expect's a response then this method is called. This method might block on a read (e.g., HTTP), put the calling thread to sleep while another thread read's the response (e.g., GIOP), or it may use the calling thread to perform the server-side work (e.g., Solaris Doors).
    
    Parameters:
    
    messageMediator -
  - unregisterWaiter
```
void unregisterWaiter(MessageMediator messageMediator)
```
    Unregister an invocation's * CorbaMessageMediator with the Connection.
    
    Parameters:
    
    messageMediator -
  - setConnectionCache
```
void setConnectionCache(ConnectionCache connectionCache)
```
  - getConnectionCache
```
ConnectionCache getConnectionCache()
```
  - hasSocketChannel
```
boolean hasSocketChannel()
```
  - write
```
void write(ByteBuffer byteBuffer)
    throws IOException
```
    Throws:
    
    IOException
  - getNextRequestId
```
int getNextRequestId()
```
  - getBroker
```
ORB getBroker()
```
  - getCodeSetContext
```
CodeSetComponentInfo.CodeSetContext getCodeSetContext()
```
  - setCodeSetContext
```
void setCodeSetContext(CodeSetComponentInfo.CodeSetContext csc)
```
  - clientRequestMapGet
```
MessageMediator clientRequestMapGet(int requestId)
```
  - clientReply_1_1_Put
```
void clientReply_1_1_Put(MessageMediator x)
```
  - clientReply_1_1_Get
```
MessageMediator clientReply_1_1_Get()
```
  - clientReply_1_1_Remove
```
void clientReply_1_1_Remove()
```
  - serverRequest_1_1_Put
```
void serverRequest_1_1_Put(MessageMediator x)
```
  - serverRequest_1_1_Get
```
MessageMediator serverRequest_1_1_Get()
```
  - serverRequest_1_1_Remove
```
void serverRequest_1_1_Remove()
```
  - isPostInitialContexts
```
boolean isPostInitialContexts()
```
  - setPostInitialContexts
```
void setPostInitialContexts()
```
  - purgeCalls
```
void purgeCalls(SystemException systemException,
                boolean die,
                boolean lockHeld)
```
  - setCodeBaseIOR
```
void setCodeBaseIOR(IOR ior)
```
  - getCodeBaseIOR
```
IOR getCodeBaseIOR()
```
  - getCodeBase
```
CodeBase getCodeBase()
```
  - sendCloseConnection
```
void sendCloseConnection(GIOPVersion giopVersion)
                  throws IOException
```
    Throws:
    
    IOException
  - sendMessageError
```
void sendMessageError(GIOPVersion giopVersion)
               throws IOException
```
    Throws:
    
    IOException
  - sendCancelRequest
```
void sendCancelRequest(GIOPVersion giopVersion,
                       int requestId)
                throws IOException
```
    Throws:
    
    IOException
  - sendCancelRequestWithLock
```
void sendCancelRequestWithLock(GIOPVersion giopVersion,
                               int requestId)
                        throws IOException
```
    Throws:
    
    IOException
  - getResponseWaitingRoom
```
ResponseWaitingRoom getResponseWaitingRoom()
```
  - serverRequestMapPut
```
void serverRequestMapPut(int requestId,
                         MessageMediator messageMediator)
```
  - serverRequestMapGet
```
MessageMediator serverRequestMapGet(int requestId)
```
  - serverRequestMapRemove
```
void serverRequestMapRemove(int requestId)
```
  - getFragmentList
```
Queue<MessageMediator> getFragmentList(RequestId corbaRequestId)
```
  - removeFragmentList
```
void removeFragmentList(RequestId corbaRequestId)
```
  - getSocketChannel
```
SocketChannel getSocketChannel()
```
  - serverRequestProcessingBegins
```
void serverRequestProcessingBegins()
```
  - serverRequestProcessingEnds
```
void serverRequestProcessingEnds()
```
  - closeConnectionResources
```
void closeConnectionResources()
```
    Clean up all connection resources. Used when shutting down an ORB.

Interface Connection

Field Summary

Method Summary

Methods inherited from interface com.sun.corba.ee.spi.legacy.connection.Connection

Field Detail

OPENING

ESTABLISHED

CLOSE_SENT

CLOSE_RECVD

ABORT

Method Detail

shouldRegisterReadEvent

shouldRegisterServerReadEvent

read

close

getAcceptor

getContactInfo

getEventHandler

isServer

isClosed

isBusy

getTimeStamp

setTimeStamp

setState

writeLock

writeUnlock

sendWithoutLock

registerWaiter

waitForResponse

unregisterWaiter

setConnectionCache

getConnectionCache

hasSocketChannel

write

getNextRequestId

getBroker

getCodeSetContext

setCodeSetContext

clientRequestMapGet

clientReply_1_1_Put

clientReply_1_1_Get

clientReply_1_1_Remove

serverRequest_1_1_Put

serverRequest_1_1_Get

serverRequest_1_1_Remove

isPostInitialContexts

setPostInitialContexts

purgeCalls

setCodeBaseIOR

getCodeBaseIOR

getCodeBase

sendCloseConnection

sendMessageError

sendCancelRequest

sendCancelRequestWithLock

getResponseWaitingRoom

serverRequestMapPut

serverRequestMapGet

serverRequestMapRemove

getFragmentList

removeFragmentList

getSocketChannel

serverRequestProcessingBegins

serverRequestProcessingEnds

closeConnectionResources