Package org.hcjf.io.net

Class NetPackage

java.lang.Object

org.hcjf.io.net.NetPackage

Direct Known Subclasses:

DefaultNetPackage, NetPackage.NetPackageWrapper

public abstract class NetPackage
extends java.lang.Object

This class represents a package of information over IP protocol.

Author:

javaito

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NetPackage.ActionEvent	Actioln events.
static class	NetPackage.NetPackageWrapper	Net package wrapper.
static class	NetPackage.PackageStatus	Transaction's status.

Constructor Summary

Constructors

Constructor	Description
NetPackage()

Method Summary

Modifier and Type	Method	Description
abstract NetPackage.ActionEvent	getActionEvent()	Return the action event.
abstract java.util.Date	getDate()	Return the creation date of the package.
java.util.UUID	getId()	Return the package id.
abstract int	getLocalPort()	Return the local port on the connections was stablished
abstract NetPackage.PackageStatus	getPackageStatus()	Return the status of the package.
abstract byte[]	getPayload()	Return the payload of the package.
abstract java.lang.String	getRemoteAddress()	Return the remote ip address.
abstract java.lang.String	getRemoteHost()	Return the address of the remote host.
abstract int	getRemotePort()	Return the port of the remote host.
abstract NetSession	getSession()	Return the net session of the package.
abstract void	setPackageStatus(NetPackage.PackageStatus packageStatus)	Set a new package status.
abstract void	setSession(NetSession session)	Set the session over the package was created.
static NetPackage	wrap(NetPackage netPackage, byte[] newPayLoad)	Create a wrapper of the net package using other pay load.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetPackage

public NetPackage()

Method Detail

getId

public final java.util.UUID getId()

Return the package id.

Returns:

Package id.

getSession

public abstract NetSession getSession()

Return the net session of the package.

Returns:

Net session.

setSession

public abstract void setSession(NetSession session)

Set the session over the package was created.

Parameters:

session - Net session

getPayload

public abstract byte[] getPayload()

Return the payload of the package.

Returns:

Payload of the package.

getRemoteAddress

public abstract java.lang.String getRemoteAddress()

Return the remote ip address.

Returns:

Remote ip address.

getRemoteHost

public abstract java.lang.String getRemoteHost()

Return the address of the remote host.

Returns:

Address of the remote host.

getRemotePort

public abstract int getRemotePort()

Return the port of the remote host.

Returns:

Port of the remote host.

getLocalPort

public abstract int getLocalPort()

Return the local port on the connections was stablished

Returns:

Local port.

getDate

public abstract java.util.Date getDate()

Return the creation date of the package.

Returns:

Creation date of the package.

getActionEvent

public abstract NetPackage.ActionEvent getActionEvent()

Return the action event.

Returns:

Action event.

getPackageStatus

public abstract NetPackage.PackageStatus getPackageStatus()

Return the status of the package.

Returns:

Package's status.

setPackageStatus

public abstract void setPackageStatus(NetPackage.PackageStatus packageStatus)

Set a new package status.

Parameters:

packageStatus - Package's status

wrap

public static final NetPackage wrap(NetPackage netPackage,
                                    byte[] newPayLoad)

Create a wrapper of the net package using other pay load.

Parameters:

netPackage - Package to wrap.

newPayLoad - New pay load.

Returns:

Net package wrapper.