Package org.simpleframework.transport
Class TransportChannel
- java.lang.Object
-
- org.simpleframework.transport.TransportChannel
-
- All Implemented Interfaces:
Channel
public class TransportChannel extends java.lang.Object implements Channel
TheTransportChannel
provides a means to deliver and receive content over a transport. This essentially provides two adapters which enable simpler communication with the underlying transport. They hide the complexities involved with buffering and resetting data written to and read from the socket.- Author:
- Niall Gallagher
- See Also:
TransportProcessor
-
-
Constructor Summary
Constructors Constructor Description TransportChannel(Transport transport)
Constructor for theTransportChannel
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Because the channel represents a duplex means of communication there needs to be a means to close it down.java.util.Map
getAttributes()
This returns theMap
of attributes used to hold connection information for the channel.Certificate
getCertificate()
This is used to acquire the SSL certificate used for security.ByteCursor
getCursor()
This provides aByteCursor
for this channel.java.nio.channels.SocketChannel
getSocket()
This is the connected socket channel associated with this.Trace
getTrace()
This gets theTrace
object associated with the channel.ByteWriter
getWriter()
This provides aByteWriter
for the channel.boolean
isSecure()
This is used to determine if the channel is secure and that data read from and data written to the request is encrypted.
-
-
-
Constructor Detail
-
TransportChannel
public TransportChannel(Transport transport) throws java.io.IOException
Constructor for theTransportChannel
object. The transport channel basically wraps a channel and provides a means to send and receive data using specialized adapters. These adapters provide a simpler means for communicating over the network to the connected client.- Parameters:
transport
- this is the underlying transport to be used- Throws:
java.io.IOException
-
-
Method Detail
-
isSecure
public boolean isSecure()
This is used to determine if the channel is secure and that data read from and data written to the request is encrypted. Channels transferred over SSL are considered secure and will have this return true, otherwise it will return false.
-
getCertificate
public Certificate getCertificate()
This is used to acquire the SSL certificate used for security. If the socket is connected to an SSL transport this returns an SSL certificate which was provided during the secure handshake between the client and server. If not certificates are present in the provided instance, a challenge can be issued.- Specified by:
getCertificate
in interfaceChannel
- Returns:
- the SSL certificate provided by a secure transport
-
getTrace
public Trace getTrace()
This gets theTrace
object associated with the channel. The trace is used to log various events for the life of the transaction such as low level read and write events as well as milestone events and errors.
-
getSocket
public java.nio.channels.SocketChannel getSocket()
This is the connected socket channel associated with this. In order to determine if content can be read or written to or from the channel this socket can be used with a selector. This provides a means to react to I/O events as they occur rather than polling the channel which is generally less performant.
-
getAttributes
public java.util.Map getAttributes()
This returns theMap
of attributes used to hold connection information for the channel. The attributes here are taken from the pipeline attributes and may contain details such as SSL certificates or other such useful information.- Specified by:
getAttributes
in interfaceChannel
- Returns:
- returns the attributes associated with the channel
-
getCursor
public ByteCursor getCursor()
This provides aByteCursor
for this channel. The cursor provides a seekable view of the input buffer and will allow the server kernel to peek into the input buffer without having to take the data from the input. This allows overflow to be pushed back on to the cursor for subsequent reads.
-
getWriter
public ByteWriter getWriter()
This provides aByteWriter
for the channel. This is used to provide a blocking output mechanism for the channel. Enabling blocking reads ensures that output buffering can be limited to an extent, which ensures that memory remains low at high load periods. Writes to the sender may result in the data being copied and queued until the socket is write ready.
-
close
public void close()
Because the channel represents a duplex means of communication there needs to be a means to close it down. This provides such a means. By closing the channel the cursor and sender will no longer send or receive data to or from the network. The client will also be signalled that the connection has been severed.
-
-