Skip navigation links

com.oblix.access
Interface ObResourceRequestInterface

All Known Implementing Classes:

ObResourceRequest

Deprecated. Defines an Interface for the classs that represents a resource request for which access operations are to be performed.

public interface ObResourceRequestInterface

ObResourceRequest objects represent access resources as defined by:

• the resource type, either built-in (for example, http or ejb) or custom, defined using the Access System Console,
• the name of the resource in the NetPoint name space,
• the operation to be performed against the resource, with allowed operations defined by resource type; for example, GET for http resources,
• optionally, a set of parameters (name-value pairs) for the requested operation; parameter names and values must be character strings.

The ObResourceRequest constructors get policy information about the resource request from the NetPoint Access System:

• whether the resource request is protected by NetPoint policies, and if so
• which authentication, authorization, and audit policies apply to the resource request and
• the authentication scheme defined in the applicable authentication policy.

  Method Summary

  void	finalize() Deprecated. Cleans up native ObResourceRequest objects.
  java.util.Hashtable	getAuthorizationParameters() Deprecated. Returns parameters required for authorization of the resource.
  java.lang.String	getOperation() Deprecated. Returns Http method for a given ObResourceRequest object
  java.util.Hashtable	getParameters() Deprecated. Returns query parameters used to define a resource.
  java.lang.String	getResource() Deprecated. Returns resource
  java.lang.String	getResourceType() Deprecated. Returns resource type
  boolean	isProtected() Deprecated. Checks if the resource defined by the ObResourceRequest is protected

  Method Detail

  isProtected

  boolean isProtected()
                      throws ObAccessException
  

  Deprecated.

  Checks if the resource defined by the ObResourceRequest is protected

  Returns:

  Boolean true if resource is protected.

  Throws:

  ObAccessException - In case server could not determine the protected status of the resource or some other error

  getResourceType

  java.lang.String getResourceType()
  

  Deprecated.

  Returns resource type

  Returns:

  String representing resource type

  getResource

  java.lang.String getResource()
  

  Deprecated.

  Returns resource

  Returns:

  String representing the resource

  getOperation

  java.lang.String getOperation()
  

  Deprecated.

  Returns Http method for a given ObResourceRequest object

  Returns:

  Http method for a given ObResourceRequest object

  getParameters

  java.util.Hashtable getParameters()
  

  Deprecated.

  Returns query parameters used to define a resource.

  Returns:

  Hashtable of query parameters in form of name/value pairs of String type used to define a resource. It returns null value if query parameters were not passed while creating ObResourceRequest object.

  getAuthorizationParameters

  java.util.Hashtable getAuthorizationParameters()
  

  Deprecated.

  Returns parameters required for authorization of the resource. Parameters will be returned only if a authorization request fails with ERR_NEED_MORE_DATA error. This error indicates that additional information is required for authorization.

  Returns:

  Hashtable containing parameters of String type required for authorization of the resource. It returns null if called before performing any authorization or if authorization for this resource has never failed with ERR_NEED_MORE_DATA error.

  Throws:

  ObAccessException - In case if resource request object is not initialized.

  finalize

  void finalize()
  

  Deprecated.

  Cleans up native ObResourceRequest objects. It is recommended that applications using Access Server API use finalize() methods for the resources that are no longer in use, instead of relying on Java Garbage Collection.