org.restlet.data
Class Protocol

java.lang.Object
  extended by org.restlet.data.Metadata
      extended by org.restlet.data.Protocol

public final class Protocol
extends Metadata

Protocol used by client and server connectors. Connectors enable the communication between components by implementing standard protocols.

Author:
Jerome Louvel (contact@noelios.com)

Field Summary
static Protocol AJP
          AJP 1.3 protocol to communicate with Apache HTTP server or Microsoft IIS.
static Protocol ALL
          All protocols wildcard.
static Protocol CLAP
          CLAP (ClassLoader Access Protocol) is a custom scheme to access to representations via classloaders.
static Protocol FILE
          Local file system access protocol.
static Protocol FTP
          FILE is a standard scheme to access to representations stored in the file system (locally most of the time).
static Protocol HTTP
          HTTP protocol.
static Protocol HTTPS
          HTTPS protocol (via SSL socket).
static Protocol JAR
          JAR (Java ARchive) is a common scheme to access to representations inside archive files.
static Protocol JDBC
          JDBC protocol.
static Protocol SMTP
          SMTP protocol.
static Protocol SMTP_STARTTLS
          SMTP with STARTTLS protocol (started with a plain socket).
static Protocol SMTPS
          SMTPS protocol (via SSL/TLS socket).
static int UNKNOWN_PORT
          Indicates that the port number is undefined.
static Protocol WAR
          Local Web Archive access protocol.
 
Constructor Summary
Protocol(String schemeName)
          Constructor.
Protocol(String schemeName, String name, String description, int defaultPort)
          Constructor.
 
Method Summary
 boolean equals(Object object)
          
 int getDefaultPort()
          Returns the default port number.
 String getSchemeName()
          Returns the URI scheme name.
 int hashCode()
          
static Protocol valueOf(String schemeName)
          Creates the protocol associated to a URI scheme name.
 
Methods inherited from class org.restlet.data.Metadata
getDescription, getName, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

UNKNOWN_PORT

public static final int UNKNOWN_PORT
Indicates that the port number is undefined.

See Also:
Constant Field Values

ALL

public static final Protocol ALL
All protocols wildcard.


AJP

public static final Protocol AJP
AJP 1.3 protocol to communicate with Apache HTTP server or Microsoft IIS.


CLAP

public static final Protocol CLAP
CLAP (ClassLoader Access Protocol) is a custom scheme to access to representations via classloaders. Example URI: "clap://thread/org/restlet/Restlet.class".

In order to work, CLAP requires a client connector provided by the core Restlet engine.

See Also:
LocalReference

WAR

public static final Protocol WAR
Local Web Archive access protocol.


FILE

public static final Protocol FILE
Local file system access protocol.


FTP

public static final Protocol FTP
FILE is a standard scheme to access to representations stored in the file system (locally most of the time). Example URI: "file:///D/root/index.html".

In order to work, FILE requires a client connector provided by the core Restlet engine.

See Also:
LocalReference

HTTP

public static final Protocol HTTP
HTTP protocol.


HTTPS

public static final Protocol HTTPS
HTTPS protocol (via SSL socket).


JAR

public static final Protocol JAR
JAR (Java ARchive) is a common scheme to access to representations inside archive files. Example URI: "jar:http://www.foo.com/bar/baz.jar!/COM/foo/Quux.class".

See Also:
LocalReference

JDBC

public static final Protocol JDBC
JDBC protocol.


SMTP

public static final Protocol SMTP
SMTP protocol.


SMTP_STARTTLS

public static final Protocol SMTP_STARTTLS
SMTP with STARTTLS protocol (started with a plain socket).


SMTPS

public static final Protocol SMTPS
SMTPS protocol (via SSL/TLS socket).

Constructor Detail

Protocol

public Protocol(String schemeName)
Constructor.

Parameters:
schemeName - The scheme name.

Protocol

public Protocol(String schemeName,
                String name,
                String description,
                int defaultPort)
Constructor.

Parameters:
schemeName - The scheme name.
name - The unique name.
description - The description.
defaultPort - The default port.
Method Detail

valueOf

public static Protocol valueOf(String schemeName)
Creates the protocol associated to a URI scheme name. If an existing constant exists then it is returned, otherwise a new instance is created.

Parameters:
schemeName - The scheme name.
Returns:
The associated protocol.

equals

public boolean equals(Object object)

Overrides:
equals in class Metadata

getDefaultPort

public int getDefaultPort()
Returns the default port number.

Returns:
The default port number.

getSchemeName

public String getSchemeName()
Returns the URI scheme name.

Returns:
The URI scheme name.

hashCode

public int hashCode()

Overrides:
hashCode in class Metadata


Copyright © 2005-2007 Noelios Technologies.