SSLIOSession (cloudwise-mobile-obfus 1.6.5 API)

java.lang.Object
- depends.org.apache.http.nio.reactor.ssl.SSLIOSession

所有已实现的接口:: IOSession, SessionBufferStatus, SocketAccessor

@ThreadSafe
public class SSLIOSession
extends java.lang.Object
implements IOSession, SessionBufferStatus, SocketAccessor

SSLIOSession is a decorator class intended to transparently extend an IOSession with transport layer security capabilities based on the SSL/TLS protocol.

The resultant instance of SSLIOSession must be added to the original I/O session as an attribute with the SESSION_KEY key.

  SSLContext sslcontext = SSLContext.getInstance("SSL");
  sslcontext.init(null, null, null);
  SSLIOSession sslsession = new SSLIOSession(
      iosession, SSLMode.CLIENT, sslcontext, null);
  iosession.setAttribute(SSLIOSession.SESSION_KEY, sslsession);

从以下版本开始:: 4.2

字段概要

字段
限定符和类型字段和说明

static java.lang.String SESSION_KEY
Name of the context attribute key, which can be used to obtain the SSL session.
- 从接口继承的字段 depends.org.apache.http.nio.reactor.IOSession
  ACTIVE, ATTACHMENT_KEY, CLOSED, CLOSING

字段
限定符和类型	字段和说明
`static java.lang.String`	`SESSION_KEY` Name of the context attribute key, which can be used to obtain the SSL session.

构造器概要

构造器
构造器和说明
`SSLIOSession(IOSession session, SSLMode sslMode, javax.net.ssl.SSLContext sslContext, SSLSetupHandler handler)` Creates new instance of `SSLIOSession` class.

方法概要

方法
限定符和类型	方法和说明
`java.nio.channels.ByteChannel`	`channel()` Returns the underlying I/O channel associated with this session.
`void`	`clearEvent(int op)` Clears interest in a particular I/O event category by updating the event mask associated with the session.
`void`	`close()` Terminates the session gracefully and closes the underlying I/O channel.
`java.lang.Object`	`getAttribute(java.lang.String name)` Returns the value of the attribute with the given name.
`int`	`getEventMask()` Returns mask of I/O evens this session declared interest in.
`java.net.SocketAddress`	`getLocalAddress()` Returns local address.
`java.net.SocketAddress`	`getRemoteAddress()` Returns address of the remote peer.
`java.net.Socket`	`getSocket()` Return the underlying socket
`int`	`getSocketTimeout()` Returns value of the socket timeout in milliseconds.
`javax.net.ssl.SSLSession`	`getSSLSession()`
`protected SSLSetupHandler`	`getSSLSetupHandler()`
`int`	`getStatus()` Returns status of the session: `IOSession.ACTIVE`: session is active.
`boolean`	`hasBufferedInput()` Determines if the input buffer associated with the session contains data.
`boolean`	`hasBufferedOutput()` Determines if the output buffer associated with the session contains data.
`void`	`inboundTransport()` Executes inbound SSL transport operations.
`void`	`initialize()` Initializes the session.
`void`	`initialize(SSLMode sslMode)` 已过时。 (4.3) SSL mode must be set at construction time.
`boolean`	`isAppInputReady()` Reads encrypted data and returns whether the channel associated with this session has any decrypted inbound data available for reading.
`boolean`	`isAppOutputReady()` Returns whether the channel associated with this session is ready to accept outbound unecrypted data for writing.
`boolean`	`isClosed()` Determines if the session has been terminated.
`boolean`	`isInboundDone()` Returns whether the session will produce any more inbound data.
`boolean`	`isInitialized()` Returns `true` is the session has been fully initialized, `false` otherwise.
`boolean`	`isOutboundDone()` Returns whether the session will accept any more outbound data.
`void`	`outboundTransport()` Sends encrypted data and executes outbound SSL transport operations.
`java.lang.Object`	`removeAttribute(java.lang.String name)` Removes attribute with the given name.
`void`	`setAttribute(java.lang.String name, java.lang.Object obj)` This method can be used to associate a particular object with the session by the given attribute name.
`void`	`setBufferStatus(SessionBufferStatus status)` Quite often I/O sessions need to maintain internal I/O buffers in order to transform input / output data prior to returning it to the consumer or writing it to the underlying channel.
`void`	`setEvent(int op)` Declares interest in a particular I/O event category by updating the event mask associated with the session.
`void`	`setEventMask(int ops)` Declares interest in I/O event notifications by setting the event mask associated with the session
`void`	`setSocketTimeout(int timeout)` Sets value of the socket timeout in milliseconds.
`void`	`shutdown()` Terminates the session by shutting down the underlying I/O channel.
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - SESSION_KEY
```
public static final java.lang.String SESSION_KEY
```
    Name of the context attribute key, which can be used to obtain the SSL session.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - SSLIOSession
```
public SSLIOSession(IOSession session,
            SSLMode sslMode,
            javax.net.ssl.SSLContext sslContext,
            SSLSetupHandler handler)
```
    Creates new instance of SSLIOSession class.
    
    参数:
    session - I/O session to be decorated with the TLS/SSL capabilities.
    sslMode - SSL mode (client or server)
    sslContext - SSL context to use for this I/O session.
    handler - optional SSL setup handler. May be null.
- 方法详细资料
  - getSSLSetupHandler
```
protected SSLSetupHandler getSSLSetupHandler()
```
  - isInitialized
```
public boolean isInitialized()
```
    Returns true is the session has been fully initialized, false otherwise.
  - initialize
```
@Deprecated
public void initialize(SSLMode sslMode)
                throws javax.net.ssl.SSLException
```
    已过时。 (4.3) SSL mode must be set at construction time.
    
    Initializes the session in the given SSLMode. This method invokes the SSLSetupHandler.initalize(SSLEngine) callback if an instance of SSLSetupHandler was specified at the construction time.
    
    抛出:
    
    javax.net.ssl.SSLException
  - initialize
```
public void initialize()
                throws javax.net.ssl.SSLException
```
    Initializes the session. This method invokes the SSLSetupHandler.initalize(SSLEngine) callback if an instance of SSLSetupHandler was specified at the construction time.
    
    抛出:
    
    javax.net.ssl.SSLException - in case of a SSL protocol exception.
    
    java.lang.IllegalStateException - if the session has already been initialized.
  - getSSLSession
```
public javax.net.ssl.SSLSession getSSLSession()
```
  - isAppInputReady
```
public boolean isAppInputReady()
                        throws java.io.IOException
```
    Reads encrypted data and returns whether the channel associated with this session has any decrypted inbound data available for reading.
    
    抛出:
    
    java.io.IOException - in case of an I/O error.
  - isAppOutputReady
```
public boolean isAppOutputReady()
                         throws java.io.IOException
```
    Returns whether the channel associated with this session is ready to accept outbound unecrypted data for writing.
    
    抛出:
    
    java.io.IOException - - not thrown currently
  - inboundTransport
```
public void inboundTransport()
                      throws java.io.IOException
```
    Executes inbound SSL transport operations.
    
    抛出:
    
    java.io.IOException - - not thrown currently
  - outboundTransport
```
public void outboundTransport()
                       throws java.io.IOException
```
    Sends encrypted data and executes outbound SSL transport operations.
    
    抛出:
    
    java.io.IOException - in case of an I/O error.
  - isInboundDone
```
public boolean isInboundDone()
```
    Returns whether the session will produce any more inbound data.
  - isOutboundDone
```
public boolean isOutboundDone()
```
    Returns whether the session will accept any more outbound data.
  - close
```
public void close()
```
    从接口复制的说明: IOSession
    
    Terminates the session gracefully and closes the underlying I/O channel. This method ensures that session termination handshake, such as the one used by the SSL/TLS protocol, is correctly carried out.
    
    指定者:
    
    close 在接口中 IOSession
  - shutdown
```
public void shutdown()
```
    从接口复制的说明: IOSession
    
    Terminates the session by shutting down the underlying I/O channel.
    
    指定者:
    
    shutdown 在接口中 IOSession
  - getStatus
```
public int getStatus()
```
    从接口复制的说明: IOSession
    
    Returns status of the session:
    IOSession.ACTIVE: session is active.
    IOSession.CLOSING: session is being closed.
    IOSession.CLOSED: session has been terminated.
    
    指定者:
    
    getStatus 在接口中 IOSession
    
    返回:
    session status.
  - isClosed
```
public boolean isClosed()
```
    从接口复制的说明: IOSession
    
    Determines if the session has been terminated.
    
    指定者:
    
    isClosed 在接口中 IOSession
    
    返回:
    true if the session has been terminated, false otherwise.
  - channel
```
public java.nio.channels.ByteChannel channel()
```
    从接口复制的说明: IOSession
    
    Returns the underlying I/O channel associated with this session.
    
    指定者:
    
    channel 在接口中 IOSession
    
    返回:
    the I/O channel.
  - getLocalAddress
```
public java.net.SocketAddress getLocalAddress()
```
    从接口复制的说明: IOSession
    
    Returns local address.
    
    指定者:
    
    getLocalAddress 在接口中 IOSession
    
    返回:
    socket address.
  - getRemoteAddress
```
public java.net.SocketAddress getRemoteAddress()
```
    从接口复制的说明: IOSession
    
    Returns address of the remote peer.
    
    指定者:
    
    getRemoteAddress 在接口中 IOSession
    
    返回:
    socket address.
  - getEventMask
```
public int getEventMask()
```
    从接口复制的说明: IOSession
    
    Returns mask of I/O evens this session declared interest in.
    
    指定者:
    
    getEventMask 在接口中 IOSession
    
    返回:
    I/O event mask.
  - setEventMask
```
public void setEventMask(int ops)
```
    从接口复制的说明: IOSession
    
    Declares interest in I/O event notifications by setting the event mask associated with the session
    
    指定者:
    
    setEventMask 在接口中 IOSession
    
    参数:
    ops - new I/O event mask.
  - setEvent
```
public void setEvent(int op)
```
    从接口复制的说明: IOSession
    
    Declares interest in a particular I/O event category by updating the event mask associated with the session.
    
    指定者:
    
    setEvent 在接口中 IOSession
    
    参数:
    op - I/O event category.
  - clearEvent
```
public void clearEvent(int op)
```
    从接口复制的说明: IOSession
    
    Clears interest in a particular I/O event category by updating the event mask associated with the session.
    
    指定者:
    
    clearEvent 在接口中 IOSession
    
    参数:
    op - I/O event category.
  - getSocketTimeout
```
public int getSocketTimeout()
```
    从接口复制的说明: IOSession
    
    Returns value of the socket timeout in milliseconds. The value of 0 signifies the session cannot time out.
    
    指定者:
    
    getSocketTimeout 在接口中 IOSession
    
    返回:
    socket timeout.
  - setSocketTimeout
```
public void setSocketTimeout(int timeout)
```
    从接口复制的说明: IOSession
    
    Sets value of the socket timeout in milliseconds. The value of 0 signifies the session cannot time out.
    
    指定者:
    
    setSocketTimeout 在接口中 IOSession
    
    参数:
    timeout - socket timeout.
  - hasBufferedInput
```
public boolean hasBufferedInput()
```
    从接口复制的说明: IOSession
    
    Determines if the input buffer associated with the session contains data.
    
    指定者:
    
    hasBufferedInput 在接口中 IOSession
    
    指定者:
    
    hasBufferedInput 在接口中 SessionBufferStatus
    
    返回:
    true if the session input buffer contains data, false otherwise.
  - hasBufferedOutput
```
public boolean hasBufferedOutput()
```
    从接口复制的说明: IOSession
    
    Determines if the output buffer associated with the session contains data.
    
    指定者:
    
    hasBufferedOutput 在接口中 IOSession
    
    指定者:
    
    hasBufferedOutput 在接口中 SessionBufferStatus
    
    返回:
    true if the session output buffer contains data, false otherwise.
  - setBufferStatus
```
public void setBufferStatus(SessionBufferStatus status)
```
    从接口复制的说明: IOSession
    
    Quite often I/O sessions need to maintain internal I/O buffers in order to transform input / output data prior to returning it to the consumer or writing it to the underlying channel. Memory management in HttpCore NIO is based on the fundamental principle that the data consumer can read only as much input data as it can process without having to allocate more memory. That means, quite often some input data may remain unread in one of the internal or external session buffers. The I/O reactor can query the status of these session buffers, and make sure the consumer gets notified correctly as more data gets stored in one of the session buffers, thus allowing the consumer to read the remaining data once it is able to process it
    I/O sessions can be made aware of the status of external session buffers using the SessionBufferStatus interface.
    
    指定者:
    
    setBufferStatus 在接口中 IOSession
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String name)
```
    从接口复制的说明: IOSession
    
    Returns the value of the attribute with the given name. The value can be null if not set.
    The value of the session attachment object can be obtained using IOSession.ATTACHMENT_KEY name.
    
    指定者:
    
    getAttribute 在接口中 IOSession
    
    参数:
    name - name of the attribute.
    
    返回:
    value of the attribute.
    另请参阅:
    IOSession.setAttribute(String, Object)
  - removeAttribute
```
public java.lang.Object removeAttribute(java.lang.String name)
```
    从接口复制的说明: IOSession
    
    Removes attribute with the given name.
    
    指定者:
    
    removeAttribute 在接口中 IOSession
    
    参数:
    name - name of the attribute to be removed.
    
    返回:
    value of the removed attribute.
    另请参阅:
    IOSession.setAttribute(String, Object)
  - setAttribute
```
public void setAttribute(java.lang.String name,
                java.lang.Object obj)
```
    从接口复制的说明: IOSession
    
    This method can be used to associate a particular object with the session by the given attribute name.
    I/O sessions are not bound to an execution thread, therefore one cannot use the context of the thread to store a session's state. All details about a particular session must be stored within the session itself.
    
    指定者:
    
    setAttribute 在接口中 IOSession
    
    参数:
    name - name of the attribute.
    obj - value of the attribute.
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - getSocket
```
public java.net.Socket getSocket()
```
    从接口复制的说明: SocketAccessor
    
    Return the underlying socket
    
    指定者:
    
    getSocket 在接口中 SocketAccessor
    
    返回:
    - the underlying Socket, may be null.

类 SSLIOSession

字段概要

从接口继承的字段 depends.org.apache.http.nio.reactor.IOSession

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

SESSION_KEY

构造器详细资料

SSLIOSession

方法详细资料

getSSLSetupHandler

isInitialized

initialize

initialize

getSSLSession

isAppInputReady

isAppOutputReady

inboundTransport

outboundTransport

isInboundDone

isOutboundDone

close

shutdown

getStatus

isClosed

channel

getLocalAddress

getRemoteAddress

getEventMask

setEventMask

setEvent

clearEvent

getSocketTimeout

setSocketTimeout

hasBufferedInput

hasBufferedOutput

setBufferStatus

getAttribute

removeAttribute

setAttribute

toString

getSocket