lumis.portal.service
Class ServiceConfig

java.lang.Object
  lumis.portal.service.ServiceConfig

@StableMinor(version="6.1",
             sinceVersion="4.0")
public class ServiceConfig
extends java.lang.Object

Holds configuration information of a service.

Since:

4.0.0

Constructor Summary

ServiceConfig()

Method Summary

java.lang.String	getAccessControlListId()
java.lang.String	getBaseUrl()
java.lang.String	getContextPath() Returns the contextPath where this service config is installed.
java.lang.String	getDefinition()
org.w3c.dom.Node	getDefinitionXmlNode()
java.lang.String	getDescription()
java.util.Enumeration	getExtendedProperties(java.lang.String name)
java.lang.String	getExtendedProperty(java.lang.String name)
java.util.Enumeration	getExtendedPropertyNames()
java.lang.String	getId()
java.lang.String	getImage()
java.lang.String	getImplementationClass()
java.lang.String	getName()
java.util.Enumeration	getProperties(java.lang.String name)
java.lang.String	getProperty(java.lang.String name)
java.util.Enumeration	getPropertyNames()
IResource	getResource()
java.lang.String	getResourceClassName()
java.lang.String	getServiceType()
java.lang.String	getSmallImage() Returns the icon for this service.
java.lang.String	getStringsUrlPrefix()
java.util.List<java.lang.String>	getStringsUrlPrefixes()
java.lang.String	getWorkflowId()
boolean	isInstantiable()
boolean	isSocialProfile() Returns whether this service can be used as a social profile information source.
boolean	isWorkflowEnabled()
boolean	isWorkflowSupported()
void	setAccessControlListId(java.lang.String accessControlListId)
void	setBaseUrl(java.lang.String baseUrl)
void	setDefinition(org.w3c.dom.Node serviceXmlNode)
void	setDefinition(java.lang.String interfaceDefinition)
void	setDescription(java.lang.String description)
void	setId(java.lang.String id)
void	setImage(java.lang.String image)
void	setImplementationClass(java.lang.String implementationClass)
void	setInstantiable(boolean isInstantiable)
void	setName(java.lang.String name)
void	setSocialProfile(boolean isSocialProfile) Sets whether this service can be used as a social profile information source.
void	setStringsUrlPrefix(java.lang.String stringsUrlPrefix)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceConfig

public ServiceConfig()

Method Detail

getDefinition

public java.lang.String getDefinition()
                               throws java.lang.Exception

Returns:

Returns the definition.

Throws:

java.lang.Exception

getDefinitionXmlNode

public org.w3c.dom.Node getDefinitionXmlNode()

Returns:

Returns the definition.

setDefinition

public void setDefinition(java.lang.String interfaceDefinition)
                   throws java.lang.Exception

Parameters:

definition - The definition to set.

Throws:

java.lang.Exception

setDefinition

public void setDefinition(org.w3c.dom.Node serviceXmlNode)
                   throws java.lang.Exception

Parameters:

definition - The definition to set.

Throws:

java.lang.Exception

getId

public java.lang.String getId()

Returns:

Returns the serviceId.

getBaseUrl

public java.lang.String getBaseUrl()

Returns:

Returns the id.

getContextPath

public java.lang.String getContextPath()

Returns the contextPath where this service config is installed. If null, it is installed in the same context as the portal framework.

Returns:

the contextPath the contextPath where this service config is installed, or null if it is installed in the same context as the portal.

Since:

4.0.7

getStringsUrlPrefixes

public java.util.List<java.lang.String> getStringsUrlPrefixes()

Returns:

Returns the stringsUrlPrefix array.

getStringsUrlPrefix

public java.lang.String getStringsUrlPrefix()

Returns:

Returns the first (main) stringsUrlPrefix.

getDescription

public java.lang.String getDescription()

Returns:

Returns the description.

getImage

public java.lang.String getImage()

Returns:

Returns the image.

getSmallImage

public java.lang.String getSmallImage()

Returns the icon for this service.

Returns:

the icon href, or null if there is no icon.

Since:

4.0.3

getName

public java.lang.String getName()

Returns:

Returns the name.

getImplementationClass

public java.lang.String getImplementationClass()

setImplementationClass

public void setImplementationClass(java.lang.String implementationClass)

getProperty

public java.lang.String getProperty(java.lang.String name)

getProperties

public java.util.Enumeration getProperties(java.lang.String name)

getPropertyNames

public java.util.Enumeration getPropertyNames()

getExtendedProperty

public java.lang.String getExtendedProperty(java.lang.String name)

getExtendedProperties

public java.util.Enumeration getExtendedProperties(java.lang.String name)

getExtendedPropertyNames

public java.util.Enumeration getExtendedPropertyNames()

getResource

public IResource getResource()

isWorkflowSupported

public boolean isWorkflowSupported()

isWorkflowEnabled

public boolean isWorkflowEnabled()

getWorkflowId

public java.lang.String getWorkflowId()

isSocialProfile

public boolean isSocialProfile()

Returns whether this service can be used as a social profile information source.

Returns:

whether this service can be used as a social profile information source.

Since:

6.1.0

setSocialProfile

public void setSocialProfile(boolean isSocialProfile)

Sets whether this service can be used as a social profile information source.

Parameters:

isSocialProfile - whether this service can be used as a social profile information source.

Since:

6.1.0

getServiceType

public java.lang.String getServiceType()

Returns:

Returns the serviceType.

getResourceClassName

public java.lang.String getResourceClassName()

Returns:

Returns the resourceClassName.

getAccessControlListId

public java.lang.String getAccessControlListId()

setAccessControlListId

public void setAccessControlListId(java.lang.String accessControlListId)

isInstantiable

public boolean isInstantiable()

setInstantiable

public void setInstantiable(boolean isInstantiable)

setBaseUrl

public void setBaseUrl(java.lang.String baseUrl)

setDescription

public void setDescription(java.lang.String description)

setId

public void setId(java.lang.String id)

setImage

public void setImage(java.lang.String image)

setName

public void setName(java.lang.String name)

setStringsUrlPrefix

public void setStringsUrlPrefix(java.lang.String stringsUrlPrefix)