javax.microedition.io
Class SocketProtocolPermission

java.lang.Object
  java.security.Permission
      javax.microedition.io.GCFPermission
          javax.microedition.io.SocketProtocolPermission

public final class SocketProtocolPermission

extends GCFPermission

This class represents access rights to connections via the "socket" protocol. A SocketProtocolPermission consists of a URI string but no actions list.

The URI string specifies a socket stream connection. It takes the following general form:

 socket://{host}:{portspec} | socket://[:{portspec}]
 

The exact syntax for the SocketProtocolPermission URI is provided by this BNF. The value of the {host} field must be a symbolic hostname, a literal IPv4 address or a literal IPv6 address, as specified by RFC 3986. The {host} field is omitted to indicate a "server mode" connection. Server-mode URIs may also omit the {portspec} field to indicate a system-assigned port number. In such a case, the SocketProtocolPermission is normalized to the equivalent URI "socket://:1024-65535".

If the {host} string is a DNS name, an asterisk may appear in the leftmost position to indicate a match of 1 or more entire domain labels. Partial domain label matches are not permitted, therefore "*.sun.com" is valid, but "*sun.com" is not. An asterisk by itself matches all hosts in "client-mode" connections;

The {portspec} string takes the following form:

 portnumber | -portnumber | portnumber-[portnumber] | "*"
 

A {portspec} specification of the form "N-" (where N is a port number) signifies all ports numbered N and above, while a specification of the form "-N" indicates all ports numbered N and below. A single asterisk may be used in place of the {portspec} field to indicate all ports. Therefore, the URI "socket://:*" matches server-mode socket connections to all ports, and the URI "socket://*:*" matches client-mode socket connections to all hosts on all ports.

See Also:

Connector.open(java.lang.String), "javax.microedition.io.SocketConnection" in MIDP 3.0 Specification

Constructor Summary

SocketProtocolPermission(String uri)
Creates a new SocketProtocolPermission with the specified URI as its name.

Method Summary

boolean	equals(Object obj) Checks two SocketProtocolPermission objects for equality.
String	getActions() Returns the canonical string representation of the actions, which currently is the empty string "", since there are no actions defined for SocketProtocolPermission.
int	hashCode() Returns the hash code value for this object.
boolean	implies(Permission p) Checks if this SocketProtocolPermission object "implies" the specified permission.
PermissionCollection	newPermissionCollection() Returns a new PermissionCollection for storing SocketProtocolPermission objects.

Methods inherited from class javax.microedition.io.GCFPermission

getProtocol, getURI

Methods inherited from class java.security.Permission

getName, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SocketProtocolPermission

public SocketProtocolPermission(String uri)

Creates a new SocketProtocolPermission with the specified URI as its name. The URI string must conform to the specification given above, and is normalized to facilitate subsequent comparisons.

Parameters:

uri - the URI string.

Throws:

IllegalArgumentException - if uri is malformed.

NullPointerException - if uri is null.

See Also:

Permission.getName()

Method Detail

implies

public boolean implies(Permission p)

Checks if this SocketProtocolPermission object "implies" the specified permission.

Because the {host} field of the permission URI may indicate an individual host by means of either a symbolic hostname or an IP address, a thorough evaluation of the implies relation between two SocketProtocolPermission objects requires the underlying platform to be able to transform symbolic hostnames into IP addresses (via address lookup) and vice-versa (via name lookup). Either service may be unavailable on a given platform. As a result, the comparison of URI strings from two permissions can only be best-effort. For each SocketProtocolPermission constructed with a URI that contains a {host} field, the implementation will attempt to determine both the fully-qualified domain name (the "canonical name") and the IP address(es) of the host. However, either value may be unknown.

To determine whether this object implies another permission, p, this method first ensures that all of the following are true (and returns false if any of them are not):

• p is an instanceof SocketProtocolPermission, and

• p's port range is included in this port range.

Then implies checks each of the following, in order, and for each returns true if the stated condition is true:

• If both this object and p lack the {host} field.

• If this object has a single IP address and one of p's IP addresses is equal to this object's IP address.

• If this object has a wildcard domain (such as *.sun.com), and p's absolute name (the name with any preceding * removed) ends with this object's absolute name. For example, *.sun.com implies *.eng.sun.com.

• If this object has multiple IP addresses, and one of this object's IP addresses equals one of p's IP addresses.

• If this object's canonical name equals p's canonical name.

If none of the above are true, implies returns false.

Specified by:

implies in class Permission

Parameters:

p - the permission to check against.

Returns:

true if the specified permission is implied by this object, false if not.

equals

public boolean equals(Object obj)

Checks two SocketProtocolPermission objects for equality.

Specified by:

equals in class Permission

Parameters:

obj - the object we are testing for equality with this object.

Returns:

true if obj is a SocketProtocolPermission and has the same URI string as this SocketProtocolPermission object.

hashCode

public int hashCode()

Returns the hash code value for this object.

Specified by:

hashCode in class Permission

Returns:

a hash code value for this object.

getActions

public String getActions()

Returns the canonical string representation of the actions, which currently is the empty string "", since there are no actions defined for SocketProtocolPermission.

Specified by:

getActions in class Permission

Returns:

the empty string "".

newPermissionCollection

public PermissionCollection newPermissionCollection()

Returns a new PermissionCollection for storing SocketProtocolPermission objects.

SocketProtocolPermission objects must be stored in a manner that allows them to be inserted into the collection in any order, but that also enables the PermissionCollection implies method to be implemented in an efficient (and consistent) manner.

Overrides:

newPermissionCollection in class Permission

Returns:

a new PermissionCollection suitable for storing SocketProtocolPermission objects.