com.goldencode.p2j.security

Class WebServiceResource

java.lang.Object

com.goldencode.expr.Scope

com.goldencode.p2j.security.AbstractResource

com.goldencode.p2j.security.StringConditionResource

com.goldencode.p2j.security.WebServiceResource

All Implemented Interfaces:

Resource

public class WebServiceResource
extends StringConditionResource

Implements the resource to set permissions for web services. Instances of this resource control access to web services, based on their type, API path and for SOAP, the target operation.

The supported web services are REST, WEBHANDLER and SOAP. The syntax is enforced only for exact matches:

• For REST, it is REST:HTTP-METHOD:/path/to/api
• For WEBHANDLER, it is WEBHANDLER:HTTP-METHOD:/path/to/api
• For SOAP, it is SOAP:HTTP-METHOD:/path/to/endpoint:namespace/binding/operation

For all cases, the first part with the service type (REST, SOAP or WEBHANDLER) and the second part with the HTTP Method (PUT, GET, DELETE, etc) is mandatory.

The web service path or SOAP endpoint are all relative to the basepath, and any address set at the service implementation LegacyService.address() annotation. So, if the basepath is /rest/ and the address set is foo, the resolved path is /rest/foo/path/to/api.

For SOAP, the target operation must be specified via the namespace/binding/operation triplet.

Field Summary

Fields inherited from class com.goldencode.p2j.security.AbstractResource

objectPointer, resourceIndex, sm

Constructor Summary

Constructors

Constructor and Description
WebServiceResource()

Method Summary

Modifier and Type	Method and Description
Rights	getRightsInstance(java.lang.Object[] rights) Instantiates a plugin's class that implements the Rights interface, using the array of objects representing a set of access rights fields.
java.lang.String	getTypeName() Returns the plugin resource type name as a string.
boolean	isInstanceNameValid(java.lang.String resource) Checks whether a given string is a valid resource name for this resource type.

Methods inherited from class com.goldencode.p2j.security.StringConditionResource

describeRights, isAllowed, isRightsSetValid

Methods inherited from class com.goldencode.p2j.security.AbstractResource

associate, attach, disassociate, getACLMatcher, getEnclosingScope, getLibrary, getLink, getPermissions, init, refresh, registeredAs, toString

Methods inherited from class com.goldencode.expr.Scope

getLibraries, getLibraryClasses, getLibsByClass, getVariableList, getVariables

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WebServiceResource

public WebServiceResource()

Method Detail

getTypeName

public java.lang.String getTypeName()

Returns the plugin resource type name as a string.

Specified by:

getTypeName in interface Resource

Overrides:

getTypeName in class StringConditionResource

Returns:

plugin resource type name

getRightsInstance

public Rights getRightsInstance(java.lang.Object[] rights)

Instantiates a plugin's class that implements the Rights interface, using the array of objects representing a set of access rights fields.

Specified by:

getRightsInstance in interface Resource

Overrides:

getRightsInstance in class StringConditionResource

Parameters:

rights - The objects needed to create an access rights instance.

Returns:

The newly created rights instance.

isInstanceNameValid

public boolean isInstanceNameValid(java.lang.String resource)

Checks whether a given string is a valid resource name for this resource type.

Specified by:

isInstanceNameValid in interface Resource

Overrides:

isInstanceNameValid in class StringConditionResource

Parameters:

resource - A string naming a resource.

Returns:

true if the name is syntactically correct.