javax.microedition.io

Class DatagramProtocolPermission

java.lang.Object

java.security.Permission

javax.microedition.io.GCFPermission

javax.microedition.io.DatagramProtocolPermission

public final class DatagramProtocolPermission
extends GCFPermission

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

The URI string specifies a connection for sending and receiving datagrams. It takes the following form:

 datagram://[{host}][:{portrange}]
 

If the {host} string is a DNS name, an asterisk may appear in the leftmost position to indicate a wildcard match (e.g., "*.sun.com"). The URI string "datagram://*" matches all "client mode" connections; the string "datagram://" specifies a "server mode" connection.

The {portrange} string takes the following form:

 portnumber | -portnumber | portnumber-[portnumber]
 

A {portrange} 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.

See Also:

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

Constructor Summary

Constructors

Constructor and Description
DatagramProtocolPermission(String uri) Creates a new DatagramProtocolPermission with the specified URI as its name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks two DatagramProtocolPermission 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 DatagramProtocolPermission.
int	hashCode() Returns the hash code value for this object.
boolean	implies(Permission p) Checks if this DatagramProtocolPermission object "implies" the specified permission.
PermissionCollection	newPermissionCollection() Returns a new PermissionCollection for storing DatagramProtocolPermission 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

DatagramProtocolPermission

public DatagramProtocolPermission(String uri)

Creates a new DatagramProtocolPermission with the specified URI as its name. The URI string must conform to the specification given above.

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 DatagramProtocolPermission object "implies" the specified permission.

More specifically, this method first ensures that all of the following are true (and returns false if any of them are not):

• p is an instanceof DatagramProtocolPermission, 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 this object was initialized with a single IP address and one of p's IP addresses is equal to this object's IP address.

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

• If this object was not initialized with a single IP address, and one of this object's IP addresses equals one of p's IP addresses.

• If this 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 DatagramProtocolPermission 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 DatagramProtocolPermission and has the same URI string as this DatagramProtocolPermission object.

See Also:

Boolean.hashCode(), Hashtable

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.

See Also:

Object.equals(java.lang.Object), Hashtable

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 DatagramProtocolPermission.

Specified by:

getActions in class Permission

Returns:

the empty string "".

newPermissionCollection

public PermissionCollection newPermissionCollection()

Returns a new PermissionCollection for storing DatagramProtocolPermission objects.

DatagramProtocolPermission 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 DatagramProtocolPermission objects.