com.sapportals.wcm.service.objecttypehandler

Class GenericObjectTypeHandler

java.lang.Object
  com.sapportals.wcm.WcmObject
      com.sapportals.wcm.service.objecttypehandler.GenericObjectTypeHandler

All Implemented Interfaces:

IObjectTypeHandler

public class GenericObjectTypeHandler
extends com.sapportals.wcm.WcmObject
implements IObjectTypeHandler

Field Summary

protected IActionList	actionList
protected String[]	extensionArray
protected Vector	extensions
protected Vector	mimeTypes
protected String	name
protected String[]	pathArray
protected Vector	paths
protected Properties	properties
protected Vector	resourceTypes

Fields inherited from class com.sapportals.wcm.WcmObject

ORDER_TYPE_MANUAL, ORDER_TYPE_NONE

Constructor Summary

GenericObjectTypeHandler()
Construct object of class GenericObjectTypeHandler.

Method Summary

IActionList	getActionList() Get the ActionList attribute of the GenericObjectTypeHandler object.
String[]	getExtensions() Get the Extensions attribute of the GenericObjectTypeHandler object.
Vector	getMimeTypes() Get the MimeTypes attribute of the GenericObjectTypeHandler object.
String	getName() Get the Name attribute of the GenericObjectTypeHandler object.
String[]	getPaths() Get the Paths attribute of the GenericObjectTypeHandler object.
Integer	getPathsHashCode() Returns identical values for identical paths arrays.
Properties	getProperties() Get the Properties attribute of the GenericObjectTypeHandler object.
Vector	getResourceTypes() Get the Properties attribute of the GenericObjectTypeHandler object.
Vector	getSourceResourceTypes() Get the resource types exclusively for a source.
Vector	getTargetResourceTypes() Get the resource types exclusively for a target.
com.sapportals.wcm.util.uri.URL	getURL(IResource resource, IActionType actionType) Get the URL attribute of the GenericObjectTypeHandler object.
com.sapportals.wcm.util.uri.URL	getURL(IResource resource, IActionType actionType, Properties props) Get the URL attribute of the GenericObjectTypeHandler object.
void	initialize(String name, Vector extensions, Vector mimeTypes, Vector paths, IActionList actionList, Vector resourceTypes, Properties props) TBD: Description of the Method.
boolean	matches(String needle) Checks if the input string matches the paths of the object.
boolean	matchesResourceType(String testResourceType, String othResourceType) Checks if testResourceType<\code> matches the othResourceType <\code>.
void	setActionList(IActionList actionList) Set the ActionList attribute of the GenericObjectTypeHandler object.
void	setExtensions(Vector extensions) Set the Extensions attribute of the GenericObjectTypeHandler object.
void	setMimeTypes(Vector mimeTypes) Set the MimeTypes attribute of the GenericObjectTypeHandler object.
void	setName(String name) Set the Name attribute of the GenericObjectTypeHandler object.
void	setPaths(Vector paths) Set the Paths attribute of the GenericObjectTypeHandler object.
void	setProperties(Properties props) Set the Properties attribute of the GenericObjectTypeHandler object.
void	setResourceTypes(Vector resourceTypes) Set the Properties attribute of the GenericObjectTypeHandler object.
void	shutDownOTH() Must be called in shutDownImpl() method of an OTH service.
void	startUpOTH() Must be called in startUp() method of an OTH service.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

resourceTypes

protected Vector resourceTypes

extensions

protected Vector extensions

mimeTypes

protected Vector mimeTypes

paths

protected Vector paths

properties

protected Properties properties

extensionArray

protected String[] extensionArray

pathArray

protected String[] pathArray

actionList

protected IActionList actionList

Constructor Detail

GenericObjectTypeHandler

public GenericObjectTypeHandler()
                         throws com.sapportals.wcm.WcmException

Construct object of class GenericObjectTypeHandler.

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

Method Detail

setName

public void setName(String name)

Set the Name attribute of the GenericObjectTypeHandler object.

Parameters:

name - The new Name value

setActionList

public void setActionList(IActionList actionList)

Set the ActionList attribute of the GenericObjectTypeHandler object.

Parameters:

actionList - The new ActionList value

setResourceTypes

public void setResourceTypes(Vector resourceTypes)

Set the Properties attribute of the GenericObjectTypeHandler object.

Parameters:

resourceTypes - resourceTypes to be set

setProperties

public void setProperties(Properties props)

Set the Properties attribute of the GenericObjectTypeHandler object.

Parameters:

props - properties to be set

setExtensions

public void setExtensions(Vector extensions)

Set the Extensions attribute of the GenericObjectTypeHandler object.

Parameters:

extensions - The new Extensions value

setMimeTypes

public void setMimeTypes(Vector mimeTypes)

Set the MimeTypes attribute of the GenericObjectTypeHandler object.

Parameters:

mimeTypes - The new MimeTypes value

setPaths

public void setPaths(Vector paths)

Set the Paths attribute of the GenericObjectTypeHandler object.

Parameters:

paths - The new Paths value

matches

public boolean matches(String needle)

Description copied from interface: IObjectTypeHandler

Checks if the input string matches the paths of the object.

Specified by:

matches in interface IObjectTypeHandler

Parameters:

needle - The input string.

Returns:

matchesResourceType

public boolean matchesResourceType(String testResourceType,
                                   String othResourceType)

Description copied from interface: IObjectTypeHandler

Checks if testResourceType<\code> matches the othResourceType <\code>. Therefore othResourceType<\code> has to be one of the resource types of the object type handler.

Specified by:

matchesResourceType in interface IObjectTypeHandler

Parameters:

testResourceType - resource type to be tested.

othResourceType - resource type against which to check.

Returns:

getPathsHashCode

public Integer getPathsHashCode()

Returns identical values for identical paths arrays.

Specified by:

getPathsHashCode in interface IObjectTypeHandler

Returns:

getName

public String getName()
               throws com.sapportals.wcm.WcmException

Get the Name attribute of the GenericObjectTypeHandler object.

Specified by:

getName in interface IObjectTypeHandler

Returns:

The Name value

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getActionList

public IActionList getActionList()

Get the ActionList attribute of the GenericObjectTypeHandler object.

Specified by:

getActionList in interface IObjectTypeHandler

Returns:

The ActionList value

getURL

public com.sapportals.wcm.util.uri.URL getURL(IResource resource,
                                              IActionType actionType)
                                       throws com.sapportals.wcm.WcmException

Get the URL attribute of the GenericObjectTypeHandler object.

Specified by:

getURL in interface IObjectTypeHandler

Parameters:

resource - TBD: Description of the incoming method parameter

actionType - TBD: Description of the incoming method parameter

Returns:

The URL value

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getURL

public com.sapportals.wcm.util.uri.URL getURL(IResource resource,
                                              IActionType actionType,
                                              Properties props)
                                       throws com.sapportals.wcm.WcmException

Get the URL attribute of the GenericObjectTypeHandler object.

Specified by:

getURL in interface IObjectTypeHandler

Parameters:

resource - TBD: Description of the incoming method parameter

actionType - TBD: Description of the incoming method parameter

props - TBD: Description of the incoming method parameter

Returns:

The URL value

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getResourceTypes

public Vector getResourceTypes()

Get the Properties attribute of the GenericObjectTypeHandler object.

Specified by:

getResourceTypes in interface IObjectTypeHandler

Returns:

The Properties value

getSourceResourceTypes

public Vector getSourceResourceTypes()

Description copied from interface: IObjectTypeHandler

Get the resource types exclusively for a source. The return vector holds instances of IResourceType

Specified by:

getSourceResourceTypes in interface IObjectTypeHandler

Returns:

The ResourceTypes value, must not return null

getTargetResourceTypes

public Vector getTargetResourceTypes()

Description copied from interface: IObjectTypeHandler

Get the resource types exclusively for a target. The return vector holds instances of IResourceType

Specified by:

getTargetResourceTypes in interface IObjectTypeHandler

Returns:

The ResourceTypes value, must not return null

getProperties

public Properties getProperties()

Get the Properties attribute of the GenericObjectTypeHandler object.

Specified by:

getProperties in interface IObjectTypeHandler

Returns:

The Properties value

getExtensions

public String[] getExtensions()

Get the Extensions attribute of the GenericObjectTypeHandler object.

Specified by:

getExtensions in interface IObjectTypeHandler

Returns:

The Extensions value

getMimeTypes

public Vector getMimeTypes()

Get the MimeTypes attribute of the GenericObjectTypeHandler object.

Specified by:

getMimeTypes in interface IObjectTypeHandler

Returns:

The MimeTypes value

getPaths

public String[] getPaths()

Get the Paths attribute of the GenericObjectTypeHandler object.

Specified by:

getPaths in interface IObjectTypeHandler

Returns:

The Paths value

initialize

public void initialize(String name,
                       Vector extensions,
                       Vector mimeTypes,
                       Vector paths,
                       IActionList actionList,
                       Vector resourceTypes,
                       Properties props)
                throws com.sapportals.wcm.WcmException

TBD: Description of the Method.

Specified by:

initialize in interface IObjectTypeHandler

Parameters:

name - TBD: Description of the incoming method parameter

extensions - TBD: Description of the incoming method parameter

mimeTypes - TBD: Description of the incoming method parameter

paths - TBD: Description of the incoming method parameter

actionList - TBD: Description of the incoming method parameter

props - TBD: Description of the incoming method parameter

resourceTypes - TBD: Description of the incoming method parameter

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

startUpOTH

public void startUpOTH()
                throws com.sapportals.wcm.WcmException

Must be called in startUp() method of an OTH service. Gets a reference to the URLGenerator Service.

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

shutDownOTH

public void shutDownOTH()
                 throws com.sapportals.wcm.WcmException

Must be called in shutDownImpl() method of an OTH service.

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM