WebLogic Server 8.1 API Reference

weblogic.security.service
Class WebServiceResource

java.lang.Object
  |
  +--weblogic.security.service.ResourceBase
        |
        +--weblogic.security.service.WebServiceResource

public final class WebServiceResource

extends ResourceBase

The WebServiceResource class is used by a container to specify the Web Service resource (and method related to the resource) that a caller is attempting to access.

The toString format (which is produced by the ResourceBase class) for a Web Service resource is:
type=<webservices>, application=myApp, method=myMethod, signature={argumentType1, argumentType2}

Author:

Copyright © 2004 BEA Systems, Inc. All Rights Reserved.

See Also:

Serialized Form

Fields inherited from class weblogic.security.service.ResourceBase

id, length, NO_PARENT, parent, resStr, SCOPE_RESOURCE_ACTION, values

Constructor Summary

WebServiceResource()
Deprecated. As of 04/01/02.

WebServiceResource(java.lang.String application, java.lang.String contextPath, java.lang.String webService, java.lang.String method, java.lang.String[] signature)
Constructs a new WebServiceResource with a target name composed from the application, method, and signature parameters.

WebServiceResource(WebResource webResource, java.lang.String method, java.lang.String[] signature, java.lang.String[] paramNames)
Deprecated. As of 12/07/02, the constructor with the application, method and signature parameters should be used instead.

Method Summary

int	getFieldType(java.lang.String fieldName)
java.lang.String[]	getKeys() Gets keys for the WebServiceResource.
java.lang.String	getType() Gets the type of this resource (WebServiceResource).
void	initialize(java.lang.String application, java.lang.String contextPath, java.lang.String webService, java.lang.String method, java.lang.String[] signature) Deprecated. As of 04/01/02, the constructor should be used instead.
protected Resource	makeParent() Gets a Resource object that represents the parent of the current WebServiceResource.
void	reset() Deprecated. As of 04/01/02.
protected void	writeResourceString(java.lang.StringBuffer buf) Writes a string representation of the resource to buffer.

Methods inherited from class weblogic.security.service.ResourceBase

appendArrayValue, appendValue, equals, getID, getParentResource, getRepeatingFieldIndex, getRepeatingFieldTerminatingIndex, getValues, hashCode, init, init, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WebServiceResource

public WebServiceResource(java.lang.String application,
                          java.lang.String contextPath,
                          java.lang.String webService,
                          java.lang.String method,
                          java.lang.String[] signature)

Constructs a new WebServiceResource with a target name composed from the application, method, and signature parameters.

Parameters:

application - the name of the application in which the resource is deployed, as it appears in the corresponding <display-name> element. The <display-name> element is associated with an <application> element in the deployment descriptor, in an .ear file.

contextPath - the context path for the Web application.

webService - the name of the Web Service.

method - a String representing the name of the service that is to be invoked. A value of null indicates that the security policy for the resource pertains to all methods that match the other parameters of the resource specification, without consideration of the method name.

signature - an array of Strings specifying the signature of the target method. Each element in the array contains the type of that parameter, described as a fully-qualified Java class. A value of null indicates that the method being protected accepts no parameters.

WebServiceResource

public WebServiceResource(WebResource webResource,
                          java.lang.String method,
                          java.lang.String[] signature,
                          java.lang.String[] paramNames)

Deprecated. As of 12/07/02, the constructor with the application, method and signature parameters should be used instead.

Constructs a new WebServiceResource with a target name composed from the webResource, method, signature, and paramNames parameters.

Parameters:

webResource - a WebResource that is the URI used to locate the service.

method - a String representing the name of the service that is to be invoked. A value of null indicates that the security policy for the resource pertains to all methods that match the other parameters of the resource specification, without consideration of the method name.

signature - an array of Strings specifying the signature of the target method. Each element in the array contains the type of that parameter, described as a fully-qualified Java class. A value of null indicates that the method being protected accepts no parameters.

paramNames - an array of Strings with the names of the parameters for the target method. A value of null indicates that the method being protected accepts no parameters. These names are ignored.

WebServiceResource

public WebServiceResource()

Deprecated. As of 04/01/02.

Creates an empty WebServiceResource.

Method Detail

initialize

public void initialize(java.lang.String application,
                       java.lang.String contextPath,
                       java.lang.String webService,
                       java.lang.String method,
                       java.lang.String[] signature)

Deprecated. As of 04/01/02, the constructor should be used instead.

Replaces application, method, and signature parameters of the resource with the specified values.

Parameters:

application - the name of the application in which the resource is deployed, as it appears in the corresponding <display-name> element. The <display-name> element is associated with an <application> element in the deployment descriptor, in an .ear file.

contextPath - the context path for the Web application.

webService - the name of the Web Service.

method - a String representing the name of the service that is to be invoked. A value of null indicates that the security policy for the resource pertains to all methods that match the other parameters of the resource specification, without consideration of the method name.

signature - an array of Strings specifying the signature of the target method. Each element in the array contains the type of that parameter, described as a fully-qualified Java class. A value of null indicates that the method being protected accepts no parameters.

writeResourceString

protected void writeResourceString(java.lang.StringBuffer buf)

Writes a string representation of the resource to buffer.

Parameters:

buf - buffer to write to.

Overrides:

writeResourceString in class ResourceBase

getType

public java.lang.String getType()

Gets the type of this resource (WebServiceResource).

Returns:

the type of this resource, represented as a String.

getFieldType

public int getFieldType(java.lang.String fieldName)

Parameters:

fieldName - the String name of the field being queried.

Returns:

the int field type of fieldName

Overrides:

getFieldType in class ResourceBase

makeParent

protected Resource makeParent()

Gets a Resource object that represents the parent of the current WebServiceResource. If the resource does not have a parent, the value of null must be returned.

The parentage hierarchy for the WebServiceResource (that is, the values returned from successive calls to this method) is:

type=<webservices>, application=myApp, method=myMethod
type=<webservices>, application=myApp
type=<app>, application=myApp
type=<webservices>


Returns:

the Resource object of the parent resource.

Overrides:

makeParent in class ResourceBase

getKeys

public java.lang.String[] getKeys()

Gets keys for the WebServiceResource.

Returns:

an array of Strings containing the WebServiceResource's keys.

Overrides:

getKeys in class ResourceBase

reset

public void reset()

Deprecated. As of 04/01/02.

Clears the parent resource, and all the values from the WebServiceResource.

Overrides:

reset in class ResourceBase