lumis.portal.urlshortener

Interface IURLShortenerManager

All Known Implementing Classes:

URLShortenerManager

public interface IURLShortenerManager

Provides URL shortening operations.
All the operations here defined require some authenticated user, so that SessionConfig.getCurrentSessionConfig() do not return null.

Since:

6.1.0

Version:

$Revision: 22905 $ $Date: 2019-07-02 21:17:02 +0000 (Tue, 02 Jul 2019) $

Method Summary

Modifier and Type	Method and Description
IURLShortener	get(ChannelConfig channel) Returns the URL shortener for the given channel.
IURLShortener	get(ServiceInstanceConfig serviceInstance) Returns the URL shortener for the given service instance.
void	put(ChannelConfig channel, String className, Map<String,String> parameters) Sets the URL shortener for the given channel. The class name received must be one of the following: lumis.portal.urlshortener.CustomURLShortener lumis.portal.urlshortener.TinyURLShortener
void	put(ServiceInstanceConfig serviceInstance, String className, Map<String,String> parameters) Sets the URL shortener for the given service instance. The class name received must be one of the following: lumis.portal.urlshortener.CustomURLShortener lumis.portal.urlshortener.TinyURLShortener
void	remove(ChannelConfig channel) Removes the URL shortener of the given channel.
void	remove(ServiceInstanceConfig serviceInstance) Removes the URL shortener of the given service instance.

Method Detail

get

IURLShortener get(ServiceInstanceConfig serviceInstance)
           throws PortalException

Returns the URL shortener for the given service instance.

Parameters:

serviceInstance - the service instance.

Returns:

the URL shortener for the given service instance.

Throws:

PortalException

Since:

6.1.0

get

IURLShortener get(ChannelConfig channel)
           throws PortalException

Returns the URL shortener for the given channel.

Parameters:

channel - the channeç.

Returns:

the URL shortener for the given channel.

Throws:

PortalException

Since:

6.1.0

put

void put(ServiceInstanceConfig serviceInstance,
         String className,
         Map<String,String> parameters)
  throws PortalException

Sets the URL shortener for the given service instance.
The class name received must be one of the following:

• lumis.portal.urlshortener.CustomURLShortener
• lumis.portal.urlshortener.TinyURLShortener

Parameters:

serviceInstance - the service instance.

className - the class name.

parameters - the parameters to be passed to the URL shortener.

Throws:

PortalException

Since:

6.1.0

put

void put(ChannelConfig channel,
         String className,
         Map<String,String> parameters)
  throws PortalException

Sets the URL shortener for the given channel.
The class name received must be one of the following:

• lumis.portal.urlshortener.CustomURLShortener
• lumis.portal.urlshortener.TinyURLShortener

Parameters:

channel - the channel.

className - the class name.

parameters - the parameters to be passed to the URL shortener.

Throws:

PortalException

Since:

6.1.0

remove

void remove(ServiceInstanceConfig serviceInstance)
     throws PortalException

Removes the URL shortener of the given service instance.

Parameters:

serviceInstance - the service instance.

Throws:

PortalException

Since:

6.1.0

remove

void remove(ChannelConfig channel)
     throws PortalException

Removes the URL shortener of the given channel.

Parameters:

channel - the channel.

Throws:

PortalException

Since:

6.1.0