ServiceConfig

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

```
@StableMinor(version="12.3",
             sinceVersion="4.0")
public class ServiceConfig
extends Object
```
Holds configuration information of a service.

Since:

4.0.0

Version:

$Revision: 23746 $ $Date: 2020-04-07 23:14:34 +0000 (Tue, 07 Apr 2020) $

Constructor Summary

Constructors
Constructor and Description

ServiceConfig()

Constructors
Constructor and Description
`ServiceConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAccessControlListId()`
`String`	`getBaseUrl()`
`String`	`getContextPath()` Returns the contextPath where this service config is installed.
`String`	`getDefinition()`
`Node`	`getDefinitionXmlNode()`
`String`	`getDescription()`
`Enumeration`	`getExtendedProperties(String name)`
`String`	`getExtendedProperty(String name)`
`Enumeration`	`getExtendedPropertyNames()`
`String`	`getId()`
`String`	`getImage()`
`String`	`getImplementationClass()`
`String`	`getName()`
`List<IHtmlProcessor>`	`getProcessors()` Returns the `HTML processors` of this service.
`Enumeration`	`getProperties(String name)`
`String`	`getProperty(String name)`
`Enumeration`	`getPropertyNames()`
`IResource`	`getResource()`
`String`	`getResourceClassName()`
`String`	`getServiceType()`
`String`	`getSmallImage()` Returns the icon for this service.
`String`	`getStringsUrlPrefix()`
`List<String>`	`getStringsUrlPrefixes()`
`String`	`getWorkflowId()`
`boolean`	`isGoogleAnalyticsEnabled()` Returns whether the Google Analytics are enabled.
`boolean`	`isInstantiable()`
`boolean`	`isSocialProfile()` Returns whether this service can be used as a social profile information source.
`boolean`	`isWorkflowEnabled()`
`boolean`	`isWorkflowSupported()`
`void`	`setAccessControlListId(String accessControlListId)`
`void`	`setBaseUrl(String baseUrl)`
`void`	`setDefinition(Node serviceXmlNode)`
`void`	`setDefinition(String serviceDefinition)`
`void`	`setDescription(String description)`
`void`	`setId(String id)`
`void`	`setImage(String image)`
`void`	`setImplementationClass(String implementationClass)`
`void`	`setInstantiable(boolean isInstantiable)`
`void`	`setName(String name)`
`void`	`setSocialProfile(boolean isSocialProfile)` Sets whether this service can be used as a social profile information source.
`void`	`setStringsUrlPrefix(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 String getDefinition()
                     throws Exception
```
    Returns:
    
    Returns the definition.
    
    Throws:
    
    Exception
  - getDefinitionXmlNode
```
public Node getDefinitionXmlNode()
```
    Returns:
    
    Returns the definition.
  - setDefinition
```
public void setDefinition(String serviceDefinition)
                   throws Exception
```
    Parameters:
    
    definition - The definition to set.
    
    Throws:
    
    Exception
  - setDefinition
```
public void setDefinition(Node serviceXmlNode)
                   throws Exception
```
    Parameters:
    
    definition - The definition to set.
    
    Throws:
    
    Exception
  - getId
```
public String getId()
```
    Returns:
    
    Returns the serviceId.
  - getBaseUrl
```
public String getBaseUrl()
```
    Returns:
    
    Returns the id.
  - getContextPath
```
public 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 List<String> getStringsUrlPrefixes()
```
    Returns:
    
    Returns the stringsUrlPrefix array.
  - getStringsUrlPrefix
```
public String getStringsUrlPrefix()
```
    Returns:
    
    Returns the first (main) stringsUrlPrefix.
  - getDescription
```
public String getDescription()
```
    Returns:
    
    Returns the description.
  - getImage
```
public String getImage()
```
    Returns:
    
    Returns the image.
  - getSmallImage
```
public 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 String getName()
```
    Returns:
    
    Returns the name.
  - getImplementationClass
```
public String getImplementationClass()
```
  - setImplementationClass
```
public void setImplementationClass(String implementationClass)
```
  - getProperty
```
public String getProperty(String name)
```
  - getProperties
```
public Enumeration getProperties(String name)
```
  - getPropertyNames
```
public Enumeration getPropertyNames()
```
  - getExtendedProperty
```
public String getExtendedProperty(String name)
```
  - getExtendedProperties
```
public Enumeration getExtendedProperties(String name)
```
  - getExtendedPropertyNames
```
public Enumeration getExtendedPropertyNames()
```
  - getResource
```
public IResource getResource()
```
  - isWorkflowSupported
```
public boolean isWorkflowSupported()
```
  - isWorkflowEnabled
```
public boolean isWorkflowEnabled()
```
  - getWorkflowId
```
public 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 String getServiceType()
```
    Returns:
    
    Returns the serviceType.
  - getResourceClassName
```
public String getResourceClassName()
```
    Returns:
    
    Returns the resourceClassName.
  - getAccessControlListId
```
public String getAccessControlListId()
```
  - setAccessControlListId
```
public void setAccessControlListId(String accessControlListId)
```
  - isInstantiable
```
public boolean isInstantiable()
```
  - setInstantiable
```
public void setInstantiable(boolean isInstantiable)
```
  - setBaseUrl
```
public void setBaseUrl(String baseUrl)
```
  - setDescription
```
public void setDescription(String description)
```
  - setId
```
public void setId(String id)
```
  - setImage
```
public void setImage(String image)
```
  - setName
```
public void setName(String name)
```
  - setStringsUrlPrefix
```
public void setStringsUrlPrefix(String stringsUrlPrefix)
```
  - getProcessors
```
public List<IHtmlProcessor> getProcessors()
```
    Returns the HTML processors of this service. If this service has no processors, an empty list is returned.
    
    Returns:
    
    the HTML processors of this service. If this service has no processors, an empty list is returned.
    
    Since:
    
    8.2.0
  - isGoogleAnalyticsEnabled
```
public boolean isGoogleAnalyticsEnabled()
```
    Returns whether the Google Analytics are enabled.
    
    Returns:
    
    whether the Google Analytics are enabled
    
    Since:
    
    8.2.0

Class ServiceConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceConfig

Method Detail

getDefinition

getDefinitionXmlNode

setDefinition

setDefinition

getId

getBaseUrl

getContextPath

getStringsUrlPrefixes

getStringsUrlPrefix

getDescription

getImage

getSmallImage

getName

getImplementationClass

setImplementationClass

getProperty

getProperties

getPropertyNames

getExtendedProperty

getExtendedProperties

getExtendedPropertyNames

getResource

isWorkflowSupported

isWorkflowEnabled

getWorkflowId

isSocialProfile

setSocialProfile

getServiceType

getResourceClassName

getAccessControlListId

setAccessControlListId

isInstantiable

setInstantiable

setBaseUrl

setDescription

setId

setImage

setName

setStringsUrlPrefix

getProcessors

isGoogleAnalyticsEnabled