Class ServiceContainerUrl
- java.lang.Object
-
- lumis.portal.servicecontainer.ServiceContainerUrl
-
- All Implemented Interfaces:
javax.portlet.BaseURL
,javax.portlet.PortletURL
,IServiceInterfaceUrl
@Deprecated public class ServiceContainerUrl extends Object implements IServiceInterfaceUrl
Deprecated.This class will be removed in a future release. UseIServiceInterfaceUrl
instead.- Since:
- 4.0.0
- Version:
- $Revision: 24195 $ $Date: 2020-10-22 11:39:20 -0300 (Thu, 22 Oct 2020) $
- See Also:
IURLFactory.createActionURL()
,IURLFactory.createRenderURL()
-
-
Field Summary
-
Fields inherited from interface lumis.portal.serviceinterface.IServiceInterfaceUrl
ACTION_URL, EXTERNAL_URL, RENDER_URL, TARGET_SCOPE_PAGE, TARGET_SCOPE_SERVICE, TARGET_SCOPE_SERVICEINSTANCE, TARGET_SCOPE_SERVICEINTERFACE, TARGET_SCOPE_SERVICEINTERFACEINSTANCE
-
-
Constructor Summary
Constructors Constructor Description ServiceContainerUrl(int urlType)
Deprecated.This constructor accepts a parameter of one of the following values
ACTION_URL
RENDER_URL
EXTERNAL_URL
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addProperty(String arg0, String arg1)
Deprecated.String
getOpenScript(IServiceInterfaceRequest request, String controlContainerFormName, ITransaction transaction)
Deprecated.Returns the script for opening this URL based on the provided parameters.String
getOpenScript(IServiceInterfaceRequest request, OpenRuntimeInterfaceBehavior behavior, String controlContainerFormName, ITransaction transaction)
Deprecated.Returns the script for opening this URL based on the provided parameters.Map<String,String[]>
getParameterMap()
Deprecated.String[]
getParameterNames()
Deprecated.Get the given String parameter to this URL.javax.portlet.PortletMode
getPortletMode()
Deprecated.protected String
getReplaceInterfaceStateParameterName()
Deprecated.Returns the replacement interface state parameter name.protected String
getTargetId()
Deprecated.Returns the target identifier of this URL.protected int
getTargetScope()
Deprecated.Returns the target scope of this URL.String
getUrl()
Deprecated.Since 4.0.7 this method was replaced bytoString()
method, so this interface uses the same method as specified in thePortletURL
interface.int
getUrlType()
Deprecated.Returns the type of url.String
getWindowOpen(ITransaction transaction)
Deprecated.since 8.2.0 replaced bygetOpenScript(IServiceInterfaceRequest, String, ITransaction)
javax.portlet.WindowState
getWindowState()
Deprecated.void
removePublicRenderParameter(String arg0)
Deprecated.void
setBaseSecure(boolean baseSecure)
Deprecated.Sets the secure type (HTTP or HTTPS) this URL is based on.void
setBaseWebsite(IWebsite baseWebsite)
Deprecated.Sets the website this URL is based on.void
setChannelId(String channelId)
Deprecated.Set the destination channel.void
setDestinationIds(IServiceInterfaceRequest request)
Deprecated.Sets the destination page, channel, runtime service interface and runtime service instance Ids.void
setExternalUrl(String url)
Deprecated.Set external urlvoid
setPageId(String pageId)
Deprecated.Set the destination page.void
setParameter(String name, String value)
Deprecated.Sets the given String parameter to this URL.void
setParameter(String name, String[] values)
Deprecated.Sets the given String array parameter to this URL.void
setParameters(Map<String,String[]> parameters)
Deprecated.Sets a parameter map for this URL.void
setPortletMode(javax.portlet.PortletMode portletMode)
Deprecated.void
setPreviousParametersStorageId(IServiceInterfaceRequest request)
Deprecated.Sets the previous parameters storage id with the value taken from the given request.void
setProperty(String arg0, String arg1)
Deprecated.protected void
setReplacementStateParameter(ReplaceInterfacesStorage replaceInterfacesStorage, String originalPageId)
Deprecated.Sets the replacement interface storage.void
setRunTimeServiceInstanceId(String runTimeServiceInstanceId)
Deprecated.Sets the runtime service instance identifier.void
setRunTimeServiceInterfaceId(String runTimeServiceInterfaceId)
Deprecated.Sets the runtime service interface identifier.void
setSecure(boolean secure)
Deprecated.Indicated the security setting for this URL.void
setTargetScope(int targetScope, String targetId)
Deprecated.The target scope allows the service interface to send parameters to one or more service interfaces.void
setWindowState(javax.portlet.WindowState windowState)
Deprecated.String
toString()
Deprecated.Returns the service interface URL string representation to be embedded in the markup.String
toString(boolean process)
Deprecated.void
write(Writer arg0)
Deprecated.void
write(Writer arg0, boolean arg1)
Deprecated.
-
-
-
Method Detail
-
setPortletMode
public void setPortletMode(javax.portlet.PortletMode portletMode) throws javax.portlet.PortletModeException
Deprecated.- Specified by:
setPortletMode
in interfacejavax.portlet.PortletURL
- Throws:
javax.portlet.PortletModeException
-
setWindowState
public void setWindowState(javax.portlet.WindowState windowState) throws javax.portlet.WindowStateException
Deprecated.- Specified by:
setWindowState
in interfacejavax.portlet.PortletURL
- Throws:
javax.portlet.WindowStateException
-
getParameterNames
public String[] getParameterNames()
Deprecated.Get the given String parameter to this URL.
-
setParameter
public void setParameter(String name, String value)
Deprecated.Sets the given String parameter to this URL.This method replaces all parameters with the given key.
The
ServiceInterfaceURL
implementation 'x-www-form-urlencoded' encodes all parameter names and values. Developers should not encode them.A service interface container may prefix the attribute names internally in order to preserve a unique namespace for the service interface.
- Specified by:
setParameter
in interfacejavax.portlet.BaseURL
- Parameters:
name
- the parameter namevalue
- the parameter value- Throws:
IllegalArgumentException
- if name or value arenull
.
-
setParameter
public void setParameter(String name, String[] values)
Deprecated.Sets the given String array parameter to this URL.This method replaces all parameters with the given key.
The
ServiceInterfaceURL
implementation 'x-www-form-urlencoded' encodes all parameter names and values. Developers should not encode them.A service interface container may prefix the attribute names internally in order to preserve a unique namespace for the service interface.
- Specified by:
setParameter
in interfacejavax.portlet.BaseURL
- Parameters:
name
- the parameter namevalues
- the parameter values- Throws:
IllegalArgumentException
- if name or values arenull
.
-
setParameters
public void setParameters(Map<String,String[]> parameters)
Deprecated.Sets a parameter map for this URL.All previously set parameters are cleared.
The
ServiceInterfaceURL
implementation 'x-www-form-urlencoded' encodes all parameter names and values. Developers should not encode them.A service interface container may prefix the attribute names internally, in order to preserve a unique namespace for the service interface.
- Specified by:
setParameters
in interfacejavax.portlet.BaseURL
- Parameters:
parameters
- Map containing parameter names for the render phase as keys and parameter values as map values. The keys in the parameter map must be of type String. The values in the parameter map must be of type String array (String[]
).- Throws:
IllegalArgumentException
- if parameters isnull
, if any of the key/values in the Map arenull
, if any of the keys is not a String, or if any of the values is not a String array.
-
setSecure
public void setSecure(boolean secure)
Deprecated.Indicated the security setting for this URL.Secure set to
true
indicates that the service interface requests a secure connection between the client and the service interface for this URL. Secure set tofalse
indicates that the service interface does not need a secure connection for this URL. If the security is not set for a URL, it will stay the same as the current request.- Specified by:
setSecure
in interfacejavax.portlet.BaseURL
- Parameters:
secure
- true, if portlet requests to have a secure connection between its portlet window and the client; false, if the portlet does not require a secure connection.- Throws:
ServiceInterfaceSecurityException
- if the run-time environment does not support the indicated setting
-
setPageId
public void setPageId(String pageId)
Deprecated.Set the destination page. If not specified, the destination page is assumed to be the current page- Specified by:
setPageId
in interfaceIServiceInterfaceUrl
- Parameters:
pageId
-
-
setChannelId
public void setChannelId(String channelId)
Deprecated.Set the destination channel. If not specified, the destination channel is assumed to be the current channel. If the page is specified, the channel value is ignored when rendering the url.- Specified by:
setChannelId
in interfaceIServiceInterfaceUrl
- Parameters:
channelId
-
-
setRunTimeServiceInterfaceId
public void setRunTimeServiceInterfaceId(String runTimeServiceInterfaceId)
Deprecated.Description copied from interface:IServiceInterfaceUrl
Sets the runtime service interface identifier. This is usually used in pop-ups that render runtime interfaces that are not previously mounted on a page.- Specified by:
setRunTimeServiceInterfaceId
in interfaceIServiceInterfaceUrl
-
setRunTimeServiceInstanceId
public void setRunTimeServiceInstanceId(String runTimeServiceInstanceId)
Deprecated.Description copied from interface:IServiceInterfaceUrl
Sets the runtime service instance identifier. This is usually used in pop-ups that render runtime interfaces that are not previously mounted on a page. These runtime interfaces need a serviceinstanceid to be rendered.- Specified by:
setRunTimeServiceInstanceId
in interfaceIServiceInterfaceUrl
-
setPreviousParametersStorageId
public void setPreviousParametersStorageId(IServiceInterfaceRequest request)
Deprecated.Sets the previous parameters storage id with the value taken from the given request.- Parameters:
containerRequest
- the request.- Since:
- 4.0.7
-
setDestinationIds
public void setDestinationIds(IServiceInterfaceRequest request)
Deprecated.Sets the destination page, channel, runtime service interface and runtime service instance Ids.- Parameters:
request
- a request where the ids will be extracted from.
-
getTargetScope
protected final int getTargetScope()
Deprecated.Returns the target scope of this URL.- Returns:
- the target scope.
- Since:
- 5.5.0
- See Also:
setTargetScope(int, String)
-
getTargetId
protected final String getTargetId()
Deprecated.Returns the target identifier of this URL.- Returns:
- the target identifier.
- Since:
- 5.5.0
- See Also:
setTargetScope(int, String)
-
setTargetScope
public void setTargetScope(int targetScope, String targetId)
Deprecated.The target scope allows the service interface to send parameters to one or more service interfaces. The target scope requires one of the possible scopes:TARGET_SCOPE_SERVICE
TARGET_SCOPE_SERVICEINSTANCE
TARGET_SCOPE_SERVICEINTERFACE
TARGET_SCOPE_SERVICEINTERFACEINSTANCE
- Specified by:
setTargetScope
in interfaceIServiceInterfaceUrl
- Parameters:
targetScope
-targetId
-
-
setBaseWebsite
public void setBaseWebsite(IWebsite baseWebsite)
Deprecated.Sets the website this URL is based on. Only applies if the URL is generated processed (true
parameter ontoString(boolean)
).The generated URL when processed will only be relative if this URL refers to a web resource in the same website. It also depends on
baseSecure
to be valid for the destination to be relative.May be
null
if the base website is not known. In this case if the URL is generated processed, it will be absolute.- Parameters:
baseWebsite
- the base website for the URL, ornull
if it is not known.- Since:
- 6.2.0
-
setBaseSecure
public void setBaseSecure(boolean baseSecure)
Deprecated.Sets the secure type (HTTP or HTTPS) this URL is based on. Only applies if the URL is generated processed (true
parameter ontoString(boolean)
)The generated URL when processed will only be relative if this URL refers to a web resource that may be accessed in this secure type. It also depends on
baseWebsite
to be valid for the destination to be relative.Default value is
false
.- Parameters:
baseSecure
-true
if the base URL is secure,false
otherwise.- Since:
- 6.2.0
-
getUrl
@Deprecated public String getUrl() throws PortalException
Deprecated.Since 4.0.7 this method was replaced bytoString()
method, so this interface uses the same method as specified in thePortletURL
interface.Description copied from interface:IServiceInterfaceUrl
Returns the service interface URL string representation to be embedded in the markup.
Note that the returned String may not be a valid URL, as it may be rewritten by the portal/service interface-container before returning the markup to the client.- Specified by:
getUrl
in interfaceIServiceInterfaceUrl
- Returns:
- the encoded URL as a string
- Throws:
PortalException
-
toString
public String toString()
Deprecated.Description copied from interface:IServiceInterfaceUrl
Returns the service interface URL string representation to be embedded in the markup.
Note that the returned String may not be a valid URL, as it may be rewritten by the portal/service interface-container before returning the markup to the client.- Specified by:
toString
in interfacejavax.portlet.BaseURL
- Specified by:
toString
in interfaceIServiceInterfaceUrl
- Overrides:
toString
in classObject
- Returns:
- the encoded URL as a string
-
toString
public String toString(boolean process)
Deprecated.
-
getWindowOpen
@Deprecated public String getWindowOpen(ITransaction transaction) throws PortalException
Deprecated.since 8.2.0 replaced bygetOpenScript(IServiceInterfaceRequest, String, ITransaction)
Returns a window.open javascript command.- Parameters:
transaction
- the transaction for persistence access.- Returns:
- the window.open javascript command string.
- Throws:
PortalException
-
getOpenScript
public String getOpenScript(IServiceInterfaceRequest request, String controlContainerFormName, ITransaction transaction) throws PortalException
Deprecated.Returns the script for opening this URL based on the provided parameters.- Parameters:
request
- the request being processed (only needed if the inferred behavior is REPLACE).controlContainerFormName
- the control container form name (only needed if the inferred behavior is REPLACE).transaction
- the transaction to use.- Returns:
- the script for opening this URL based on the provided parameters.
- Throws:
PortalException
- Since:
- 7.0.0
-
getOpenScript
public String getOpenScript(IServiceInterfaceRequest request, OpenRuntimeInterfaceBehavior behavior, String controlContainerFormName, ITransaction transaction) throws PortalException
Deprecated.Returns the script for opening this URL based on the provided parameters.- Parameters:
request
- the request being processed (only needed if the desired behavior is not provided and the inferred behavior is REPLACE).behavior
- the desired behavior (if not provided, it will be inferred from parameters).controlContainerFormName
- the control container form name (only needed if the desired behavior is not provided and the inferred behavior is REPLACE).transaction
- the transaction to use.- Returns:
- the script for opening this URL based on the provided parameters.
- Throws:
PortalException
- Since:
- 7.0.0
-
setExternalUrl
public void setExternalUrl(String url)
Deprecated.Description copied from interface:IServiceInterfaceUrl
Set external url- Specified by:
setExternalUrl
in interfaceIServiceInterfaceUrl
-
getUrlType
public int getUrlType()
Deprecated.Returns the type of url. Valid types areIServiceInterfaceUrl.RENDER_URL
,IServiceInterfaceUrl.ACTION_URL
andIServiceInterfaceUrl.EXTERNAL_URL
- Specified by:
getUrlType
in interfaceIServiceInterfaceUrl
- Returns:
- the url type.
- Since:
- 5.0.0
-
getPortletMode
public javax.portlet.PortletMode getPortletMode()
Deprecated.- Specified by:
getPortletMode
in interfacejavax.portlet.PortletURL
-
getWindowState
public javax.portlet.WindowState getWindowState()
Deprecated.- Specified by:
getWindowState
in interfacejavax.portlet.PortletURL
-
removePublicRenderParameter
public void removePublicRenderParameter(String arg0)
Deprecated.- Specified by:
removePublicRenderParameter
in interfacejavax.portlet.PortletURL
-
addProperty
public void addProperty(String arg0, String arg1)
Deprecated.- Specified by:
addProperty
in interfacejavax.portlet.BaseURL
-
getParameterMap
public Map<String,String[]> getParameterMap()
Deprecated.- Specified by:
getParameterMap
in interfacejavax.portlet.BaseURL
-
setProperty
public void setProperty(String arg0, String arg1)
Deprecated.- Specified by:
setProperty
in interfacejavax.portlet.BaseURL
-
write
public void write(Writer arg0) throws IOException
Deprecated.- Specified by:
write
in interfacejavax.portlet.BaseURL
- Throws:
IOException
-
write
public void write(Writer arg0, boolean arg1) throws IOException
Deprecated.- Specified by:
write
in interfacejavax.portlet.BaseURL
- Throws:
IOException
-
setReplacementStateParameter
protected void setReplacementStateParameter(ReplaceInterfacesStorage replaceInterfacesStorage, String originalPageId)
Deprecated.Sets the replacement interface storage.- Parameters:
replaceInterfacesStorage
- the replacement interface storage.originalPageId
- the original page identifier.- Since:
- 7.0.0
-
getReplaceInterfaceStateParameterName
protected String getReplaceInterfaceStateParameterName()
Deprecated.Returns the replacement interface state parameter name.- Returns:
- the replacement interface state parameter name.
- Since:
- 7.0.0
-
-