com.sap.tc.webdynpro.services.sal.url.api
Class WDWebResource

java.lang.Object
  |
  +--com.sap.tc.webdynpro.services.sal.url.api.WDWebResource

public abstract class WDWebResource

extends java.lang.Object

The class WDWebResource is used to access instances of type IWDWebResource.

A web resource belongs to a deployable object part. With an IWDWebResource, it is possible to generate the URL to this object.

See Also:

IWDWebResource, WDWebResourceType

Constructor Summary

WDWebResource()

Method Summary

static IWDCachedWebResource	getCachedWebResource(java.lang.Object key, WDScopeType scopetype) Returns the cached web resource with a supplied key as identification and the scopetype for defining the scope in which the resource is searched.
static IWDCachedWebResource	getPublicCachedWebResource(byte[] webResource, WDWebResourceType resourceType, WDScopeType scopeType, WDDeployableObjectPart deployableObjectpart, java.lang.String key) returns a IWDCachedWebResource, which is saved directly to the WDDeployableObject directory.
static IWDCachedWebResource	getPublicCachedWebResource(java.io.InputStream webResource, WDWebResourceType resourceType, WDScopeType scopeType, WDDeployableObjectPart deployableObjectpart, java.lang.String key) returns a IWDCachedWebResource, which is saved directly to the WDDeployableObject directory.
static IWDCachedWebResource	getWebResource(byte[] webResource, WDWebResourceType resourceType) Returns an IWDWebResource for a given web resource.
static IWDCachedWebResource	getWebResource(java.io.InputStream input, WDWebResourceType resourceType) Returns an IWDWebResource for a given web resource.
static IWDWebResource	getWebResource(WDDeployableObjectPart deployableObjectPart) Return is the IWDWebResource object that represents a Web Dynpro application, i.e.
static IWDWebResource	getWebResource(WDDeployableObjectPart deployableObjectPart, WDWebResourceType resourceType, java.lang.String resourceName) Return is the IWDWebResource object that represents the specified web resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

WDWebResource

public WDWebResource()

Method Detail

getWebResource

public static IWDWebResource getWebResource(WDDeployableObjectPart deployableObjectPart)

Return is the IWDWebResource object that represents a Web Dynpro application, i.e. the URL of this Web resource points to the associated application.

Parameters:

deployableObjectPart - a deployable object part

Returns:

the web resource representation

getWebResource

public static IWDWebResource getWebResource(WDDeployableObjectPart deployableObjectPart,
                                            WDWebResourceType resourceType,
                                            java.lang.String resourceName)

Return is the IWDWebResource object that represents the specified web resource. The resource is specified by its type and name.

Parameters:

deployableObjectPart - a deployable object part

resourceType - the type of the resource as defined by WDWebResourceType

resourceName - the name of the web resource

Returns:

the web resource representation

getWebResource

public static IWDCachedWebResource getWebResource(byte[] webResource,
                                                  WDWebResourceType resourceType)

Returns an IWDWebResource for a given web resource. If the supplied input parameter makePersistent is set to true, the web resource is made persistent.

Parameters:

webResource - the web resource as byte array

resourceType - the MIME type

Returns:

the web resource if existing; otherwise null is returned

getWebResource

public static IWDCachedWebResource getWebResource(java.io.InputStream input,
                                                  WDWebResourceType resourceType)

Returns an IWDWebResource for a given web resource.

Parameters:

webResource - the web resource as byte array

resourceType - the MIME type

Returns:

the web resource if existing; otherwise null is returned

getPublicCachedWebResource

public static IWDCachedWebResource getPublicCachedWebResource(byte[] webResource,
                                                              WDWebResourceType resourceType,
                                                              WDScopeType scopeType,
                                                              WDDeployableObjectPart deployableObjectpart,
                                                              java.lang.String key)

returns a IWDCachedWebResource, which is saved directly to the WDDeployableObject directory. Its lifetime is defined over WDScopeType. It is cached and saved with the given key. The developer has to be sure, that it is identifiable over the defined scope This resource gets an public web resource: it is available on the server as public web resource, like an image

Parameters:

webResource - - the stream/bytearray

resourceType - - the content type of the bytearray

scopeType - - the lifetime scopetype

deployableObjectPart - - the deployableobject, in which directory the cached source is saved

key - - the name/key of the resource

Returns:

the wrapper for the resource

getPublicCachedWebResource

public static IWDCachedWebResource getPublicCachedWebResource(java.io.InputStream webResource,
                                                              WDWebResourceType resourceType,
                                                              WDScopeType scopeType,
                                                              WDDeployableObjectPart deployableObjectpart,
                                                              java.lang.String key)

returns a IWDCachedWebResource, which is saved directly to the WDDeployableObject directory. Its lifetime is defined over WDScopeType. It is cached and saved with the given key. The developer has to be sure, that it is identifiable over the defined scope This resource gets an public web resource: it is available on the server as public web resource, like an image

Parameters:

webResource - - the stream/bytearray

resourceType - - the content type of the bytearray

scopeType - - the lifetime scopetype

deployableObjectPart - - the deployableobject, in which directory the cached source is saved

key - - the name/key of the resource

Returns:

the wrapper for the resource

getCachedWebResource

public static IWDCachedWebResource getCachedWebResource(java.lang.Object key,
                                                        WDScopeType scopetype)
                                                 throws WDResourceNotFoundException

Returns the cached web resource with a supplied key as identification and the scopetype for defining the scope in which the resource is searched.

Parameters:

key, - the key to find the cached web resource

scopetype, - defines the scope in which the resource is searched

Returns:

the cached IWDCachedWebResource if existing; otherwise null is returned