org.licas_internet.conn

Class LicasWebConnection

java.lang.Object

org.licas_internet.conn.LicasHttpConnection

org.licas_internet.conn.LicasWebConnection

All Implemented Interfaces:

java.lang.AutoCloseable

public class LicasWebConnection
extends LicasHttpConnection
implements java.lang.AutoCloseable

This class models an http connection through the web using GET and POST.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.licas_internet.conn.LicasHttpConnection

connInfo

Constructor Summary

Constructors

Constructor and Description
LicasWebConnection(ConnectionInfo theConnInfo) Create a new instance of LicasWebConnection.

Method Summary

Modifier and Type	Method and Description
void	close() Do some tidy-up
void	connect() Make the connection.
void	connect(java.util.HashMap<java.lang.String,java.lang.String> rProperties) Make a GET or POST connection and send the message.
void	disconnect() Disconnect the connection.
java.lang.Object	getConn() Get the created connection.
int	getResponseCode() Get the response code to the request.
boolean	isBound() Return true if bound to an address.
boolean	isConnected() Return true if connected to the source.

Methods inherited from class org.licas_internet.conn.LicasHttpConnection

isSocketConnection, isUrlConnection

Methods inherited from class java.lang.Object

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

Constructor Detail

LicasWebConnection

public LicasWebConnection(ConnectionInfo theConnInfo)
                   throws java.lang.Exception

Create a new instance of LicasWebConnection.

Parameters:

theConnInfo - the full connection info.

Throws:

java.lang.Exception - any error.

Method Detail

isConnected

public boolean isConnected()

Return true if connected to the source.

Specified by:

isConnected in class LicasHttpConnection

Returns:

true if connected, false otherwise.

isBound

public boolean isBound()

Return true if bound to an address.

Specified by:

isBound in class LicasHttpConnection

Returns:

true if bound, false otherwise.

getResponseCode

public int getResponseCode()

Get the response code to the request.

Returns:

the value of getResponseCode on the connection.

connect

public void connect()
             throws java.lang.Exception

Make the connection.

Specified by:

connect in class LicasHttpConnection

Throws:

java.lang.Exception - any error.

connect

public void connect(java.util.HashMap<java.lang.String,java.lang.String> rProperties)
             throws java.lang.Exception

Make a GET or POST connection and send the message. GET is assumed by default.

Parameters:

rProperties - a list of additional request properties to add, as in key-value. Can be empty or null.

Throws:

java.lang.Exception - any error.

disconnect

public void disconnect()

Disconnect the connection.

Specified by:

disconnect in class LicasHttpConnection

getConn

public java.lang.Object getConn()

Get the created connection.

Specified by:

getConn in class LicasHttpConnection

Returns:

the created connection.

close

public void close()

Do some tidy-up

Specified by:

close in interface java.lang.AutoCloseable