Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.http.conn.scheme
Class Scheme

    java.lang.Object
      org.apache.http.conn.scheme.Scheme

    @Immutable
    public final class Scheme

extends Object

Encapsulates specifics of a protocol scheme such as "http" or "https". Schemes are identified by lowercase names. Supported schemes are typically collected in a `SchemeRegistry`.

For example, to configure support for "https://" URLs, you could write code like the following:

     Scheme https = new Scheme("https", 443, new MySecureSocketFactory());
     SchemeRegistry registry = new SchemeRegistry();
     registry.register(https);

Since:
  4.0

Constructor Summary
`Scheme(String name, int port, SchemeSocketFactory factory)` Creates a new scheme.
`Scheme(String name, SocketFactory factory, int port)` Deprecated. (4.1) Use `Scheme(String, int, SchemeSocketFactory)`

Method Summary
`boolean` | `equals(Object obj)`
`int` | `getDefaultPort()` Obtains the default port.
`String` | `getName()` Obtains the scheme name.
`SchemeSocketFactory` | `getSchemeSocketFactory()` Obtains the socket factory.
`SocketFactory` | `getSocketFactory()` Deprecated. (4.1) Use `getSchemeSocketFactory()`
`int` | `hashCode()`
`boolean` | `isLayered()` Indicates whether this scheme allows for layered connections.
`int` | `resolvePort(int port)` Resolves the correct port for this scheme.
`String` | `toString()` Return a string representation of this object.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

### Scheme

    public Scheme(String name,
                  int port,
                  SchemeSocketFactory factory)

  Creates a new scheme. Whether the created scheme allows for layered connections depends on the class of `factory`.

  Parameters:
    `name` - the scheme name, for example "http". The name will be converted to lowercase.
    `port` - the default port for this scheme
    `factory` - the factory for creating sockets for communication with this scheme
  Since:
    4.1

### Scheme

    @Deprecated
    public Scheme(String name,
                             SocketFactory factory,
                             int port)

  Deprecated. (4.1) Use `Scheme(String, int, SchemeSocketFactory)`

  Creates a new scheme. Whether the created scheme allows for layered connections depends on the class of `factory`.

  Parameters:
    `name` - the scheme name, for example "http". The name will be converted to lowercase.
    `factory` - the factory for creating sockets for communication with this scheme
    `port` - the default port for this scheme

Method Detail

### getDefaultPort

    public final int getDefaultPort()

  Obtains the default port.

  Returns:
    the default port for this scheme

### getSocketFactory

    @Deprecated
    public final SocketFactory getSocketFactory()

  Deprecated. (4.1) Use `getSchemeSocketFactory()`

  Obtains the socket factory. If this scheme is `layered`, the factory implements `LayeredSocketFactory`.

  Returns:
    the socket factory for this scheme

### getSchemeSocketFactory

    public final SchemeSocketFactory getSchemeSocketFactory()

  Obtains the socket factory. If this scheme is `layered`, the factory implements `LayeredSchemeSocketFactory`.

  Returns:
    the socket factory for this scheme
  Since:
    4.1

### getName

    public final String getName()

  Obtains the scheme name.

  Returns:
    the name of this scheme, in lowercase

### isLayered

    public final boolean isLayered()

  Indicates whether this scheme allows for layered connections.

  Returns:
    `true` if layered connections are possible, `false` otherwise

### resolvePort

    public final int resolvePort(int port)

  Resolves the correct port for this scheme. Returns the given port if it is valid, the default port otherwise.

  Parameters:
    `port` - the port to be resolved, a negative number to obtain the default port
  Returns:
    the given port or the defaultPort

### toString

    public final String toString()

  Return a string representation of this object.

  Overrides:
    `toString` in class `Object`
  Returns:
    a human-readable string description of this scheme

### equals

    public final boolean equals(Object obj)

  Overrides:
    `equals` in class `Object`

### hashCode

    public int hashCode()

  Overrides:
    `hashCode` in class `Object`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2013 The Apache Software Foundation. All Rights Reserved.