| java.lang.Object
 org.xins.server.AccessRule
| AccessRule | | final public class AccessRule implements AccessRuleContainer(Code) | | Access rule. This class can take a character string to produce an
AccessRule object from it.
Descriptor format
A descriptor must comply to the following format:
- start with either
"allow" or "deny";
- followed by any number of white space characters;
- followed by a valid IP address;
- followed by a slash character (
'/');
- followed by a mask between 0 and 32 in decimal format, without
leading zeroes;
- followed by any number of white space characters;
- followed by a simple pattern, see class
SimplePatternParser .
Descriptor examples
Example of access rule descriptors:
"allow 194.134.168.213/32 *"- Allows 194.134.168.213 to access any function.
"deny 194.134.168.213/24 _*"- Denies all 194.134.168.x IP addresses to access any function
starting with an underscore (
'_').
version:
$Revision: 1.49 $ $Date: 2007/09/18 08:45:06 $
author:
Ernst de Haan
author:
Chris Gilbride
author:
Anthony Goubard
since:
XINS 1.0.0 |
| Method Summary | |
| public void | dispose()
Disposes this access rule. | | public IPFilter | getIPFilter()
Returns the IP filter. | | public boolean | isAllowRule()
Returns if this rule is an allow or a deny rule. | | public Boolean | isAllowed(String ip, String functionName, String conventionName)
Determines if the specified IP address is allowed to access the
specified function, returning a Boolean object or
null.
This method finds the first matching rule and then returns the
allow property of that rule (see
AccessRule.isAllowRule ). | | public boolean | match(String ip, String functionName, String conventionName)
Determines if the specified IP address and function match this rule. | | public static AccessRule | parseAccessRule(String descriptor)
Parses the specified character string to construct a new
AccessRule object. | | public String | toString()
Returns a character string representation of this object. |
| getIPFilter | | public IPFilter getIPFilter()(Code) | | Returns the IP filter.
the IPFilter associated with this access rule, nevernull. |
| isAllowRule | | public boolean isAllowRule()(Code) | | Returns if this rule is an allow or a deny rule.
true if this is an allow rule, orfalse if this is a deny rule. |
| isAllowed | | public Boolean isAllowed(String ip, String functionName, String conventionName) throws IllegalStateException, IllegalArgumentException, ParseException(Code) | | Determines if the specified IP address is allowed to access the
specified function, returning a Boolean object or
null.
This method finds the first matching rule and then returns the
allow property of that rule (see
AccessRule.isAllowRule ). If there is no matching rule, then
null is returned.
Parameters:
ip - the IP address, cannot be null.
Parameters:
functionName - the name of the function, cannot be null.
Parameters:
conventionName - the name of the calling convention, can be null.Boolean.TRUE if the specified IP address is allowed to accessthe specified function, Boolean.FALSE if it is disallowedaccess or null if there is no match.
throws:
IllegalStateException - if this object is disposed (since XINS 1.3.0).
throws:
IllegalArgumentException - if ip == null || functionName == null.
throws:
ParseException - if the specified IP address is malformed.
since:
XINS 2.1. |
| match | | public boolean match(String ip, String functionName, String conventionName) throws IllegalStateException, IllegalArgumentException, ParseException(Code) | | Determines if the specified IP address and function match this rule.
Calling this function is equivalent to calling:
AccessRule.isAllowed(String,String) isAllowed (ip,
functionName) != null
Parameters:
ip - the IP address to match, cannot be null.
Parameters:
functionName - the name of the function to match, cannot be null.
Parameters:
conventionName - the name of the calling convention to match, can be null.true if this rule matches, false otherwise.
throws:
IllegalStateException - if this access rule is disposed (since XINS 1.3.0).
throws:
IllegalArgumentException - if ip == null || functionName == null.
throws:
ParseException - if the specified IP address cannot be parsed.
since:
XINS 2.1. |
| toString | | public String toString()(Code) | | Returns a character string representation of this object. The returned
string is in the form:
type a.b.c.d/m pattern
where type is either "allow" or
"deny", a.b.c.d is the base IP address, m
is the mask, and pattern is the function name simple pattern.
a character string representation of this access rule, nevernull. |
|
|