org.ws4d.java.communication.protocol.http

Class HTTPBinding

java.lang.Object

org.ws4d.java.communication.protocol.http.HTTPBinding

All Implemented Interfaces:

IPAddressChangeListener, Binding, CommunicationBinding

Direct Known Subclasses:

HTTPSBinding

public class HTTPBinding
extends java.lang.Object
implements CommunicationBinding, IPAddressChangeListener

HTTP binding to allows access to IP devices and services.
This HTTP binding allows the creation of an HTTP address for a device or a service.

HTTPBinding addr = new HTTPBinding(new IPAddress("192.168.0.1"), 8080, "/device", CommunicationManager.getCommunicationManagerId()); The HTTP binding above will create the address http://192.168.0.1:8080/device and can be used for devices.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataStructure	bindingListenerList
protected AddressFilter	filter
protected IPAddress	ipAddress
protected int	port
protected URI	transportAddress

Constructor Summary

Constructors

Constructor and Description
HTTPBinding(IPAddress ipAddress, int port, java.lang.String path, java.lang.String comManId) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addBindingListener(BindingListener listener) Add BindingListener to the Binding.
void	addressDown(IPAddress ip) Will be called if a DiscoveryDomain is down.
void	addressUp(IPAddress ip) Will be called if a IPAddress is up.
void	checkSecurityCredentialsEquality(HTTPBinding otherBinding)
static java.lang.String	createIpPortKey(java.lang.String address, int port)
CommunicationBinding	duplicate(java.lang.String path) Duplicates this communication binding with the new path.
boolean	equals(java.lang.Object obj)
AddressFilter	getAddressFilter()
java.lang.String	getCommunicationManagerId() Returns the ID as String of the protocol/technology this binding corresponds to (e.g.
CredentialInfo	getCredentialInfo() Returns the CredentialInfo of this Binding.
java.lang.Object	getHostAddress()
IPAddress	getHostIPAddress() Returns the host address of this binding.
java.lang.String	getIpPortKey()
java.lang.Integer	getKey() Returns the unique key of the Binding.
java.lang.String	getPath() Returns the path of the HTTP address.
int	getPort() Returns the TCP port for this IP-based binding.
URI	getTransportAddress() Returns an URI for this binding.
java.lang.String	getURISchema()
int	hashCode()
boolean	isSecure() Returns true if binding is secur binding.
boolean	isUsable() Returns whether the binding is usable.
void	removeBindingListener(BindingListener listener) Remove BindingListener from the Binding.
void	resetAutoPort()
void	setAddressFilter(AddressFilter filter)
void	setCredentialInfo(CredentialInfo credentialInfo) Sets the CredentialInfo if given CredentialInfo is not null or CredentialInfo.EMPTY_CREDENTIAL_INFO.
void	setPort(int port)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ipAddress

protected IPAddress ipAddress

port

protected int port

transportAddress

protected URI transportAddress

bindingListenerList

protected DataStructure bindingListenerList

filter

protected AddressFilter filter

Constructor Detail

HTTPBinding

public HTTPBinding(IPAddress ipAddress,
                   int port,
                   java.lang.String path,
                   java.lang.String comManId)

Constructor.

Parameters:

ipAddress -

port -

path -

Method Detail

createIpPortKey

public static java.lang.String createIpPortKey(java.lang.String address,
                                               int port)

getPath

public java.lang.String getPath()

Returns the path of the HTTP address.

Returns:

the path of the HTTP address.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getKey

public java.lang.Integer getKey()

Description copied from interface: Binding

Returns the unique key of the Binding.

Specified by:

getKey in interface Binding

Returns:

the unique key

getAddressFilter

public AddressFilter getAddressFilter()

setAddressFilter

public void setAddressFilter(AddressFilter filter)

getIpPortKey

public java.lang.String getIpPortKey()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

resetAutoPort

public void resetAutoPort()

isSecure

public boolean isSecure()

Description copied from interface: CommunicationBinding

Returns true if binding is secur binding.

Specified by:

isSecure in interface CommunicationBinding

Returns:

true if binding is secur binding.

isUsable

public boolean isUsable()

Description copied from interface: Binding

Returns whether the binding is usable. If interface or address of binding is not available the binding is not usable.

Specified by:

isUsable in interface Binding

Returns:

true if the binding is usable, else false.

checkSecurityCredentialsEquality

public void checkSecurityCredentialsEquality(HTTPBinding otherBinding)
                                      throws WS4DIllegalStateException

Throws:

WS4DIllegalStateException

getCredentialInfo

public CredentialInfo getCredentialInfo()

Description copied from interface: Binding

Returns the CredentialInfo of this Binding.

Specified by:

getCredentialInfo in interface Binding

Returns:

credential info of this binding.

setCredentialInfo

public void setCredentialInfo(CredentialInfo credentialInfo)

Description copied from interface: Binding

Sets the CredentialInfo if given CredentialInfo is not null or CredentialInfo.EMPTY_CREDENTIAL_INFO.

Specified by:

setCredentialInfo in interface Binding

getTransportAddress

public URI getTransportAddress()

Description copied from interface: CommunicationBinding

Returns an URI for this binding. This URI is a transport address to access this binding.

Specified by:

getTransportAddress in interface CommunicationBinding

Returns:

an URI to access.

getURISchema

public java.lang.String getURISchema()

getCommunicationManagerId

public java.lang.String getCommunicationManagerId()

Description copied from interface: Binding

Returns the ID as String of the protocol/technology this binding corresponds to (e.g. DPWS, UPNP, Bluetooth, etc.).

Specified by:

getCommunicationManagerId in interface Binding

Returns:

the ID of this binding's protocol/technology

getHostIPAddress

public IPAddress getHostIPAddress()

Returns the host address of this binding. The host address can be either an IPv4 literal, an IPv6 literal or a DNS host name.

Returns:

the host address of this binding.

getHostAddress

public java.lang.Object getHostAddress()

Specified by:

getHostAddress in interface Binding

Returns:

For example in HTTPBinding it is an object of the class "IPAddress".

getPort

public int getPort()

Returns the TCP port for this IP-based binding.

Returns:

the TCP port for this IP-based binding.

setPort

public void setPort(int port)

Parameters:

port - the port to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

duplicate

public CommunicationBinding duplicate(java.lang.String path)

Description copied from interface: CommunicationBinding

Duplicates this communication binding with the new path.

Specified by:

duplicate in interface CommunicationBinding

Returns:

copy of this communication binding with new path.

addBindingListener

public void addBindingListener(BindingListener listener)

Description copied from interface: Binding

Add BindingListener to the Binding. If changes are performed the listener will be announced.

Specified by:

addBindingListener in interface Binding

removeBindingListener

public void removeBindingListener(BindingListener listener)

Description copied from interface: Binding

Remove BindingListener from the Binding.

Specified by:

removeBindingListener in interface Binding

addressUp

public void addressUp(IPAddress ip)

Description copied from interface: IPAddressChangeListener

Will be called if a IPAddress is up.

Specified by:

addressUp in interface IPAddressChangeListener

addressDown

public void addressDown(IPAddress ip)

Description copied from interface: IPAddressChangeListener

Will be called if a DiscoveryDomain is down.

Specified by:

addressDown in interface IPAddressChangeListener