org.sblim.slp
Class ServiceURL

java.lang.Object
  extended by org.sblim.slp.ServiceURL
All Implemented Interfaces:
java.io.Serializable

public class ServiceURL
extends java.lang.Object
implements java.io.Serializable

The ServiceURL object models the advertised SLP service URL. It can be either a service: URL or a regular URL. These objects are returned from service lookup requests, and describe the registered services. This class should be a subclass of java.net.URL but can't since that class is final.

See Also:
Serialized Form

Field Summary
static int LIFETIME_DEFAULT
          The default URL lifetime (3 hours) in seconds.
static int LIFETIME_MAXIMUM
          The maximum URL lifetime (about 18 hours) in seconds.
static int LIFETIME_NONE
          Indicates that the URL has a zero lifetime.
static int LIFETIME_PERMANENT
          Indicates that the API implementation should continuously re-register the URL until the application exits.
static int NO_PORT
          Indicates that no port information is required or was returned for this URL.
 
Constructor Summary
ServiceURL(java.lang.String pServiceURL, int pLifetime)
          Construct a service URL object having the specified lifetime.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getHost()
          Returns the host identifier.
 int getLifetime()
          Returns the service advertisement lifetime.
 int getPort()
          Returns the port number, if any.
 ServiceType getServiceType()
          Returns the service type object representing the service type name of the URL.
 java.lang.String getTransport()
          Get the network layer transport identifier.
 java.lang.String getURLPath()
          Returns the URL path description, if any.
 int hashCode()
           
 void setServiceType(ServiceType pServicetype)
          Set the service type name to the object.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NO_PORT

public static final int NO_PORT
Indicates that no port information is required or was returned for this URL.

See Also:
Constant Field Values

LIFETIME_NONE

public static final int LIFETIME_NONE
Indicates that the URL has a zero lifetime. This value is never returned from the API, but can be used to create a ServiceURL object to deregister, delete attributes, or find attributes.

See Also:
Constant Field Values

LIFETIME_DEFAULT

public static final int LIFETIME_DEFAULT
The default URL lifetime (3 hours) in seconds.

See Also:
Constant Field Values

LIFETIME_MAXIMUM

public static final int LIFETIME_MAXIMUM
The maximum URL lifetime (about 18 hours) in seconds.

See Also:
Constant Field Values

LIFETIME_PERMANENT

public static final int LIFETIME_PERMANENT
Indicates that the API implementation should continuously re-register the URL until the application exits.

See Also:
Constant Field Values
Constructor Detail

ServiceURL

public ServiceURL(java.lang.String pServiceURL,
                  int pLifetime)
Construct a service URL object having the specified lifetime.

Parameters:
pServiceURL - The URL as a string. Must be either a service: URL or a valid generic URL according to RFC 2396 [2].
pLifetime - The service advertisement lifetime in seconds. This value may be either between LIFETIME_NONE and LIFETIME_MAXIMUM or LIFETIME_PERMANENT.
Method Detail

getServiceType

public ServiceType getServiceType()
Returns the service type object representing the service type name of the URL.

Returns:
The service type

setServiceType

public void setServiceType(ServiceType pServicetype)
Set the service type name to the object. Ignored if the URL is a service: URL.

Parameters:
pServicetype - The service type object.

getTransport

public java.lang.String getTransport()
Get the network layer transport identifier. If the transport is IP, an empty string, "", is returned.

Returns:
The NLT identifier

getHost

public java.lang.String getHost()
Returns the host identifier. For IP, this will be the machine name or IP address.

Returns:
The host

getPort

public int getPort()
Returns the port number, if any. For non-IP transports, always returns NO_PORT.

Returns:
The port

getURLPath

public java.lang.String getURLPath()
Returns the URL path description, if any.

Returns:
The URL path

getLifetime

public int getLifetime()
Returns the service advertisement lifetime. This will be a positive int between LIFETIME_NONE and LIFETIME_MAXIMUM.

Returns:
The lifetime

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2005, 2009 IBM Corporation. All Rights Reserved.