public class FileURLConnection extends java.lang.Object implements URLConnection, javax.naming.Referenceable
URLConnection
resource to a local file
providing the services published by the URLConnection
.URLConnection
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
PROTOCOL |
ATTR_CONN_TYPE, ATTR_NAME, ATTR_URL, REST_CONN_TYPE
Modifier | Constructor and Description |
---|---|
protected |
FileURLConnection(java.lang.String name,
org.w3c.dom.DocumentFragment description,
java.util.Hashtable environment)
Instantiate this URLConnection instance from the description and
the corresponding environment.
|
protected |
FileURLConnection(java.lang.String name,
java.net.URL url)
Instantiate this URLConnection instance for the File URL resource
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close this connection.
|
protected org.w3c.dom.DocumentFragment |
describe()
Create the DocumentFragment that describes this connection to the
Connection Architecture.
|
boolean |
equals(java.lang.Object connection)
Tests for the equality of another URLConnection instance with the current
instance.
|
AuthenticationScheme |
getAuthenticationScheme()
Get the
AuthenticationScheme used by this connection
to authenticate against the endpoint |
java.lang.Object |
getInteraction()
Start the communication session.
|
java.lang.String |
getName()
Get the Name of this connection
|
Proxy |
getProxy()
Get the proxy details for the URL Connection.
|
javax.naming.Reference |
getReference()
Return the
Reference that describes the details of
this connection. |
int |
getTimeout()
Get the timeout set on this connection.
|
java.net.URL |
getURL()
Get the URL resource represented by this connection
|
int |
hashCode() |
void |
open()
Open the connection.
|
void |
release()
Release this connection instance back to the pool.
|
protected void |
setPool(ConnectionPool pool)
Set the Connection pool on this instance.
|
void |
setProxy(Proxy proxy)
Configure the proxy details for the URL access
|
void |
setTimeout(int timeout)
Set the timeout property for the connection.
|
java.lang.String |
toString()
Returns a String representation of this Connection.
|
protected static final java.lang.String PROTOCOL
protected FileURLConnection(java.lang.String name, java.net.URL url)
name
- The Name of this Connection.url
- The URL
for the file resourceprotected FileURLConnection(java.lang.String name, org.w3c.dom.DocumentFragment description, java.util.Hashtable environment) throws ConnectionException
name
- The Name of this Connection.description
- The DocumentFragment
describing this
connectionEnvironment
- The Environment having the necessary credential
information for this connection.{@link
- ConnectionException} if the connection instance could not
be created.ConnectionException
public java.lang.String getName()
getName
in interface URLConnection
public void open() throws ConnectionException
open
in interface URLConnection
{@link
- ConnectionException} if the connection failed to open.ConnectionException
public void setProxy(Proxy proxy)
This is not supported for the File Protocol. A {#link java.lang.UnsupportedOperationException} is thrown if the client attempts to invoke this operation on this connection instance
setProxy
in interface URLConnection
proxy
- The Proxy details needed to access the URL{#java.lang.UnsupportedOperationException}
- always when invoked on
the file connection.public Proxy getProxy()
This is not supported for the File Protocol. A null is always returned when a client invokes this operation on the file connection.
getProxy
in interface URLConnection
public java.lang.Object getInteraction() throws ConnectionException
open()
before starting the interaction. This is necessary to
initialize and prepare the atual physical channel for communication.getInteraction
in interface URLConnection
FileInteraction
that represents the underlying
communication channel.{@link
- ConnectionException} if an error occurred in starting the
interaction.ConnectionException
public AuthenticationScheme getAuthenticationScheme()
AuthenticationScheme
used by this connection
to authenticate against the endpoint
As of current implementation no Authentication schemes are supported
for this FileURLConnection. Hence a call to this API by the client will
always return null
getAuthenticationScheme
in interface URLConnection
AuthenticationScheme
used by this
connection. If the connection does not use any authentication
null
is returned.public java.net.URL getURL()
getURL
in interface URLConnection
URL
resource of this connectionpublic void setTimeout(int timeout)
setTimeout
in interface URLConnection
timeout
- The timeout to be set on the connection instance.public int getTimeout()
getTimeout
in interface URLConnection
public void close() throws ConnectionException
open()
on the connection again. Reopening the connection will reset the state
of the interaction associated with this connection.close
in interface URLConnection
{@link
- ConnectionException} if a failure occured in closing the
connection.ConnectionException
public void release() throws ConnectionException
release
in interface URLConnection
{@link
- ConnectionException} if the connection could be released to
the pool.ConnectionException
public javax.naming.Reference getReference() throws javax.naming.NamingException
Reference
that describes the details of
this connection.getReference
in interface javax.naming.Referenceable
java.naming.Reference
instance describing this
connectionjavax.naming.NamingException
- if an error was encountered.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object connection)
equals
in class java.lang.Object
true
if the connection instances are the same
false
otherwise.public java.lang.String toString()
toString
in class java.lang.Object
protected org.w3c.dom.DocumentFragment describe() throws ConnectionException
DocumentFragment
describing this connection
instance.ConnectionException
protected void setPool(ConnectionPool pool)
pool
- The ConnectionPool
from which this connection
instance was allocated.