Java Doc for SocketPermission.java in  » 6.0-JDK-Modules » j2me » java » net » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » java.net 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.security.Permission
      java.net.SocketPermission

SocketPermission
final public class SocketPermission extends Permission implements java.io.Serializable(Code)
This class represents access to a network via sockets. A SocketPermission consists of a host specification and a set of "actions" specifying ways to connect to that host. The host is specified as
 host = (hostname | IPv4address | iPv6reference) [:portrange]
 portrange = portnumber | -portnumber | portnumber-[portnumber]
 
The host is expressed as a DNS name, as a numerical IP address, or as "localhost" (for the local machine). The wildcard "*" may be included once in a DNS name host specification. If it is included, it must be in the leftmost position, as in "*.sun.com".

The format of the IPv6reference should follow that specified in RFC 2732: Format for Literal IPv6 Addresses in URLs:

 ipv6reference = "[" IPv6address "]"
 
For example, you can construct a SocketPermission instance as the following:
 String hostAddress = inetaddress.getHostAddress();
 if (inetaddress instanceof Inet6Address) {
 sp = new SocketPermission("[" + hostAddress + "]:" + port, action);
 } else {
 sp = new SocketPermission(hostAddress + ":" + port, action);
 }
 
or
 String host = url.getHost();
 sp = new SocketPermission(host + ":" + port, action);
 

The full uncompressed form of an IPv6 literal address is also valid.

The port or portrange is optional. A port 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.

The possible ways to connect to the host are

 accept
 connect
 listen
 resolve
 
The "listen" action is only meaningful when used with "localhost". The "resolve" action is implied when any of the other actions are present. The action "resolve" refers to host/ip name service lookups.

As an example of the creation and meaning of SocketPermissions, note that if the following permission:

 p1 = new SocketPermission("puffin.eng.sun.com:7777", "connect,accept");
 
is granted to some code, it allows that code to connect to port 7777 on puffin.eng.sun.com, and to accept connections on that port.

Similarly, if the following permission:

 p1 = new SocketPermission("puffin.eng.sun.com:7777", "connect,accept");
 p2 = new SocketPermission("localhost:1024-", "accept,connect,listen");
 
is granted to some code, it allows that code to accept connections on, connect to, or listen on any port between 1024 and 65535 on the local host.

Note: Granting code permission to accept or make connections to remote hosts may be dangerous because malevolent code can then more easily transfer and share confidential data among parties who may not otherwise have access to the data.
See Also:   java.security.Permissions
See Also:   SocketPermission
version:
   1.41 10/27/00
author:
   Marianne Mueller
author:
   Roland Schemers




Constructor Summary
public  SocketPermission(String host, String action)
     Creates a new SocketPermission object with the specified actions. The host is expressed as a DNS name, or as a numerical IP address. Optionally, a port or a portrange may be supplied (separated from the DNS name or IP address by a colon).

To specify the local machine, use "localhost" as the host. Also note: An empty host String ("") is equivalent to "localhost".

The actions parameter contains a comma-separated list of the actions granted for the specified host (and port(s)).

 SocketPermission(String host, int mask)
    

Method Summary
public  booleanequals(Object obj)
     Checks two SocketPermission objects for equality.
public  StringgetActions()
     Returns the canonical string representation of the actions. Always returns present actions in the following order: connect, listen, accept, resolve.
 voidgetCanonName()
    
 voidgetIP()
     get IP addresses.
 intgetMask()
     Return the current action mask.
public  inthashCode()
     Returns the hash code value for this object.
public  booleanimplies(Permission p)
     Checks if this socket permission 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 SocketPermission,

  • p's actions are a proper subset of this object's actions, and

  • p's port range is included in this port range.
 booleanimpliesIgnoreMask(SocketPermission that)
     Checks if the incoming Permission's action are a proper subset of the this object's actions.

Check, in the following order:

  • Checks that "p" is an instanceof a SocketPermission
  • Checks that "p"'s actions are a proper subset of the current object's actions.
  • Checks that "p"'s port range is included in this port range
  • If this object was initialized with an IP address, checks that one of "p"'s IP addresses is equal to this object's IP address.
  • If either object is a wildcard domain (i.e., "*.sun.com"), attempt to match based on the wildcard.
  • If this object was not initialized with an IP address, attempt to find a match based on the IP addresses in both objects.
  • Attempt to match on the canonical hostnames of both objects.

Parameters:
  p - the incoming permission request true if "permission" is a proper subset of the current object,false if not.
public  PermissionCollectionnewPermissionCollection()
     Returns a new PermissionCollection object for storing SocketPermission objects.


Constructor Detail
SocketPermission
public SocketPermission(String host, String action)(Code)
Creates a new SocketPermission object with the specified actions. The host is expressed as a DNS name, or as a numerical IP address. Optionally, a port or a portrange may be supplied (separated from the DNS name or IP address by a colon).

To specify the local machine, use "localhost" as the host. Also note: An empty host String ("") is equivalent to "localhost".

The actions parameter contains a comma-separated list of the actions granted for the specified host (and port(s)). Possible actions are "connect", "listen", "accept", "resolve", or any combination of those. "resolve" is automatically added when any of the other three are specified.

Examples of SocketPermission instantiation are the following:

 nr = new SocketPermission("www.catalog.com", "connect");
 nr = new SocketPermission("www.sun.com:80", "connect");
 nr = new SocketPermission("*.sun.com", "connect");
 nr = new SocketPermission("*.edu", "resolve");
 nr = new SocketPermission("204.160.241.0", "connect");
 nr = new SocketPermission("localhost:1024-65535", "listen");
 nr = new SocketPermission("204.160.241.0:1024-65535", "connect");
 

Parameters:
  host - the hostname or IPaddress of the computer, optionallyincluding a colon followed by a port or port range.
Parameters:
  action - the action string.



SocketPermission
SocketPermission(String host, int mask)(Code)




Method Detail
equals
public boolean equals(Object obj)(Code)
Checks two SocketPermission objects for equality.


Parameters:
  obj - the object to test for equality with this object. true if obj is a SocketPermission, and has thesame hostname, port range, and actions as thisSocketPermission object. However, port range will be ignoredin the comparison if obj only contains the action, 'resolve'.




getActions
public String getActions()(Code)
Returns the canonical string representation of the actions. Always returns present actions in the following order: connect, listen, accept, resolve. the canonical string representation of the actions.



getCanonName
void getCanonName() throws UnknownHostException(Code)
attempt to get the fully qualified domain name



getIP
void getIP() throws UnknownHostException(Code)
get IP addresses. Sets invalid to true if we can't get them.



getMask
int getMask()(Code)
Return the current action mask. the actions mask.



hashCode
public int hashCode()(Code)
Returns the hash code value for this object. a hash code value for this object.



implies
public boolean implies(Permission p)(Code)
Checks if this socket permission 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 SocketPermission,

  • p's actions are a proper subset of this object's actions, and

  • p's port range is included in this port range. Note: port range is ignored when p only contains the action, 'resolve'.

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.
Parameters:
  p - the permission to check against. true if the specified permission is implied by this object,false if not.



impliesIgnoreMask
boolean impliesIgnoreMask(SocketPermission that)(Code)
Checks if the incoming Permission's action are a proper subset of the this object's actions.

Check, in the following order:

  • Checks that "p" is an instanceof a SocketPermission
  • Checks that "p"'s actions are a proper subset of the current object's actions.
  • Checks that "p"'s port range is included in this port range
  • If this object was initialized with an IP address, checks that one of "p"'s IP addresses is equal to this object's IP address.
  • If either object is a wildcard domain (i.e., "*.sun.com"), attempt to match based on the wildcard.
  • If this object was not initialized with an IP address, attempt to find a match based on the IP addresses in both objects.
  • Attempt to match on the canonical hostnames of both objects.

Parameters:
  p - the incoming permission request true if "permission" is a proper subset of the current object,false if not.



newPermissionCollection
public PermissionCollection newPermissionCollection()(Code)
Returns a new PermissionCollection object for storing SocketPermission objects.

SocketPermission 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. a new PermissionCollection object suitable for storing SocketPermissions.




Methods inherited from java.security.Permission
public void checkGuard(Object object) throws SecurityException(Code)(Java Doc)
abstract public boolean equals(Object obj)(Code)(Java Doc)
abstract public String getActions()(Code)(Java Doc)
final public String getName()(Code)(Java Doc)
abstract public int hashCode()(Code)(Java Doc)
abstract public boolean implies(Permission permission)(Code)(Java Doc)
public PermissionCollection newPermissionCollection()(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.