com.ibm.xdms.function
Interface UriHelper

All Superinterfaces:
Function

public interface UriHelper
extends Function

The UriHelper class provides functions for processing of a URI.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.net.URI createUniqueUri(java.net.URI uri)
          Construct a unique URI based on a duplicate.
 java.net.URI createUniqueUri(XcapServerRequest request)
          Constructs a unique URI based on a configured uriTemplate REP.
 boolean validate(java.net.URI uri)
          Validate an RLS Service URI.
 
Methods inherited from interface com.ibm.xdms.function.Function
getApplicationUsage, init
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
Method Detail

validate

boolean validate(java.net.URI uri)
Validate an RLS Service URI. Called to verify the "uri" attribute of the element. This can be overridden to do something like only accept URIs with a "sip" or "sips" scheme

Parameters:
uri - URI from request
Returns:
true if this is a valid URI, false otherwise

createUniqueUri

java.net.URI createUniqueUri(java.net.URI uri)
                             throws java.net.URISyntaxException
Construct a unique URI based on a duplicate. Called by ResourceListConstraintFilter when a URI breaks a global uniqueness constraint, such as for a global index. The result is then re-tested by ResourceListConstraintFilter and this function will be invoked again if it still fails uniqueness

Parameters:
uri -
Returns:
URI
Throws:
java.net.URISyntaxException

createUniqueUri

java.net.URI createUniqueUri(XcapServerRequest request)
                             throws java.net.URISyntaxException
Constructs a unique URI based on a configured uriTemplate REP. The URI template is described by the OMA XDM 2.0 specification in Appendex D.1.

Parameters:
request - XcapServerRequest to get various information.
Returns:
Returns a unique
Throws:
java.net.URISyntaxException