Package com.axemble.vdoc.sdk.impl

Class PortalModuleImpl

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

com.axemble.vdoc.sdk.impl.CoreModule

com.axemble.vdoc.sdk.impl.PortalModuleImpl

All Implemented Interfaces:

IBasePortalModule, IModule, IPortalModule, Serializable, Remote

public class PortalModuleImpl
extends CoreModule
implements IPortalModule

Author:

vlygeros

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PortalModuleImpl.IURIConverter
static class	PortalModuleImpl.JDOPortalModule	Module fake pour gérer la sécurité sur les portlets basés sur un pm A éviter au maximum car le pm n'est libéré que par le finalize !

Field Summary

Fields

Modifier and Type	Field	Description
protected static HashMap	nativeClasses
protected static Map<String,PortalModuleImpl.IURIConverter>	uriConverters

Fields inherited from class com.axemble.vdoc.sdk.impl.CoreModule

LOGGER, properties

Constructor Summary

Constructors

Constructor	Description
PortalModuleImpl()	Deprecated. Use com.axemble.vdoc.sdk.Modules.getPortalModule() instead.

Method Summary

Modifier and Type	Method	Description
void	addAuthenticationKey(String key, IUser user, Date expirationDate, String authorizedAddress)	Adds an authenticationKey for a user The ExternalAuthenticationLoginModule will be automatically connect the user if he uses the parameter _AuthenticationKey
IConnectionDefinition<?>	createConnectionDefinition(IContext context, IOrganization organization, String name, String label, String categoryName)	Create a connection definition
IMailingList	createMailingList(IContext context, IOrganization organization, String name, String label, int type)	Creates a new mailing list.
void	createNewSession(String login)	Creates a new session.
IReport	executeTask(Class<?> extensionClass, Map<String,String> parameters)	Execute a BaseTaskExtension
Class	findNativeClass(Class interfaceClass)	Allows to retrieve the inner native class.
String	generateAuthenticationKey(IUser user, Date expirationDate, String authorizedAddress)	Generates and adds an authenticationKey for a user The ExternalAuthenticationLoginModule will be automatically connect the user if he uses the parameter _AuthenticationKey
String	generateSystemName(String label)	Generate a valid system name for this module and this label.
IAsyncJobQueueController	getAsyncJobQueueController()	Gets an AsyncJobQueue controller.
IConnectionDefinition<?>	getConnectionDefinition(IContext context, String name)	Gets a connection from its name.
Collection<? extends IConnectionDefinition<?>>	getConnectionDefinitions(IContext context)	Gets a collection of connections.
Collection<? extends IConnectionDefinition<?>>	getConnectionDefinitionsByCategoryName(IContext context, String categoryName)	Gets a connection from its name.
Collection<? extends IConnectionDefinition<?>>	getConnectionDefinitionsByTypeName(IContext context, String type)	Gets a connection from its name.
protected static PortalModuleImpl.IURIConverter	getConverter(String key)
IProtocolSupport	getElementByProtocolURI(String protocolURI)	Gets an IElement object which implements IProtocolSupport interface.
IEventController	getHistoryEventController()	Gets a History Event controller.
IIndexController	getIndexController(String name)	Gets the controller of the specified index name.
IJMSController	getJMSController()	Gets a JMS controller.
IMailingList	getMailingList(IContext context, String name, int type)	Gets a mailing list by its name.
IMailingList	getMailingList(IStorageKey key)	Gets a mailing list object from its identifier.
IMailingList	getMailingList(Object object)	Gets a mailing list object from its identifier.
Collection<? extends IMailingList>	getMailingLists(IContext context)	Gets all mailing lists.
protected static Class	getNativeClass(Class interfaceClass)
INotificationController	getNotificationController()	Get an INotificationController
IPortlet	getPortlet(IContext context, String name)	Gets a portlet by its name.
String	getProtocolURI(IProtocolSupport protocolSupport)	Gets a protocolURI from a IProtocolSupport object.
String	getProtocolURI(IProtocolSupport protocolSupport, boolean useNames)	Gets a protocolURI from a IProtocolSupport object.
ISecurityController	getSecurityController(ISecuritySupport securitySupport)	Gets a security controller on a specified object.
String	getValidatorErrorMessage(String rule, String language)	Get the validator's error message
void	killCurrentSession()	Kills the current session.
void	killSession(jakarta.servlet.http.HttpSession session)	Kills a session.
void	replaceCurrentSession(String login)	Replaces the current session.
void	send(jakarta.mail.internet.MimeMessage message)	Allows to send a message through the mail agent.
<T> boolean	validate(Collection<T> values, String... rules)	Validate values with validator's rules
<T> boolean	validate(T value, String... rules)	Validate value with validator's rules
boolean	verifyAuthentication(String login, String password)	Verifies login / password parameters against JAAS.
IUser	verifyPassword(String login, String password)	Allows to verify a password for a specified user login.
IUser	verifyPassword(String login, String password, jakarta.servlet.http.HttpServletRequest request)	Allows to verify a password for a specified user login.
IUser	verifyToken(String token)	Verifies authentication token

Methods inherited from class com.axemble.vdoc.sdk.impl.CoreModule

beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, createAttachment, createAttachment, createAttachment, createAttachment, createProfile, getAnonymous, getAnonymousContext, getComponentsFactory, getConfiguration, getContext, getContext, getContext, getContextByLogin, getDefinitionsFactory, getElementFromExternalElement, getExternalElement, getExternalElement, getLanguage, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProfile, getProfile, getProfiles, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getUser, getUser, getUserByLogin, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

getTranslation, getTranslationForLanguage, getTranslationKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.axemble.vdoc.sdk.modules.IModule

beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, getAnonymous, getAnonymousContext, getContext, getContext, getContextByLogin, getElementFromExternalElement, getExternalElement, getExternalElement, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getTranslation, getTranslationForLanguage, getTranslationKey, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize

Methods inherited from interface com.axemble.vdoc.sdk.modules.IPortalModule

getConfiguration

Field Details

uriConverters

protected static Map<String,PortalModuleImpl.IURIConverter> uriConverters

nativeClasses

protected static HashMap nativeClasses

Constructor Details

PortalModuleImpl

@Deprecated
public PortalModuleImpl()

Deprecated.

Use com.axemble.vdoc.sdk.Modules.getPortalModule() instead.

Method Details

getConverter

protected static PortalModuleImpl.IURIConverter getConverter(String key)

getElementByProtocolURI

public IProtocolSupport getElementByProtocolURI(String protocolURI)
                                         throws ModuleException

Description copied from interface: IPortalModule

Gets an IElement object which implements IProtocolSupport interface.

Specified by:

getElementByProtocolURI in interface IBasePortalModule

Specified by:

getElementByProtocolURI in interface IPortalModule

Overrides:

getElementByProtocolURI in class CoreModule

Parameters:

protocolURI - The protocol URI as a java.lang.String.

Returns:

A IProtocolSupport object.

Throws:

ModuleException - default module exception.

getProtocolURI

public String getProtocolURI(IProtocolSupport protocolSupport)
                      throws ModuleException

Description copied from interface: IPortalModule

Gets a protocolURI from a IProtocolSupport object.

Specified by:

getProtocolURI in interface IBasePortalModule

Specified by:

getProtocolURI in interface IPortalModule

Parameters:

protocolSupport - The object to convert into a protocolURI.

Returns:

A String short protocolURI.

Throws:

ModuleException - default module exception.

getProtocolURI

public String getProtocolURI(IProtocolSupport protocolSupport,
 boolean useNames)
                      throws ModuleException

Description copied from interface: IPortalModule

Gets a protocolURI from a IProtocolSupport object.

Specified by:

getProtocolURI in interface IBasePortalModule

Specified by:

getProtocolURI in interface IPortalModule

Parameters:

protocolSupport - The object to convert into a protocolURI.

useNames - use short URI (with id) or long URI (with system names)

Returns:

A String protocolURI.

Throws:

ModuleException - default module exception.

getNativeClass

protected static Class getNativeClass(Class interfaceClass)

findNativeClass

public Class findNativeClass(Class interfaceClass)

Description copied from interface: IModule

Allows to retrieve the inner native class.

Specified by:

findNativeClass in interface IModule

Overrides:

findNativeClass in class CoreModule

Parameters:

interfaceClass - A class type.

Returns:

The inner native class.

createNewSession

public void createNewSession(String login)
                      throws PortalModuleException

Description copied from interface: IPortalModule

Creates a new session.

Specified by:

createNewSession in interface IBasePortalModule

Specified by:

createNewSession in interface IPortalModule

Parameters:

login - The login of the user to create the session.

Throws:

PortalModuleException - default module exception.

killCurrentSession

public void killCurrentSession()
                        throws PortalModuleException

Description copied from interface: IPortalModule

Kills the current session.

Specified by:

killCurrentSession in interface IBasePortalModule

Specified by:

killCurrentSession in interface IPortalModule

Throws:

PortalModuleException - default module exception.

killSession

public void killSession(jakarta.servlet.http.HttpSession session)
                 throws PortalModuleException

Description copied from interface: IPortalModule

Kills a session.

Specified by:

killSession in interface IBasePortalModule

Specified by:

killSession in interface IPortalModule

Parameters:

session - the session to kill

Throws:

PortalModuleException - default module exception.

replaceCurrentSession

public void replaceCurrentSession(String login)
                           throws PortalModuleException

Description copied from interface: IPortalModule

Replaces the current session.

Specified by:

replaceCurrentSession in interface IBasePortalModule

Specified by:

replaceCurrentSession in interface IPortalModule

Parameters:

login - The login of the user to replace the session with.

Throws:

PortalModuleException - default module exception.

addAuthenticationKey

public void addAuthenticationKey(String key,
 IUser user,
 Date expirationDate,
 String authorizedAddress)
                          throws PortalModuleException

Description copied from interface: IPortalModule

Adds an authenticationKey for a user The ExternalAuthenticationLoginModule will be automatically connect the user if he uses the parameter _AuthenticationKey

Specified by:

addAuthenticationKey in interface IBasePortalModule

Specified by:

addAuthenticationKey in interface IPortalModule

Parameters:

key - the authentication key

user - the user to connect

expirationDate - (the authentication key will be valid until this date)

authorizedAddress - (the user will be able to connect only from these ip addresses : null to allow any address)

Throws:

PortalModuleException - default module exception.

generateAuthenticationKey

public String generateAuthenticationKey(IUser user,
 Date expirationDate,
 String authorizedAddress)
                                 throws PortalModuleException

Description copied from interface: IPortalModule

Generates and adds an authenticationKey for a user The ExternalAuthenticationLoginModule will be automatically connect the user if he uses the parameter _AuthenticationKey

Specified by:

generateAuthenticationKey in interface IBasePortalModule

Specified by:

generateAuthenticationKey in interface IPortalModule

Parameters:

user - the user to connect

expirationDate - (the authentication key will be valid until this date)

authorizedAddress - (the user will be able to connect only from these ip addresses : null to allow any address)

Returns:

the authentication key

Throws:

PortalModuleException - default module exception.

getPortlet

public IPortlet getPortlet(IContext context,
 String name)
                    throws PortalModuleException

Description copied from interface: IPortalModule

Gets a portlet by its name.

Specified by:

getPortlet in interface IBasePortalModule

Specified by:

getPortlet in interface IPortalModule

Parameters:

context - The execution context.

name - The name of the IPortlet object.

Returns:

The IPortlet object.

Throws:

PortalModuleException - default module exception.

getSecurityController

public ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                          throws PortalModuleException

Description copied from interface: IPortalModule

Gets a security controller on a specified object.

Specified by:

getSecurityController in interface IBasePortalModule

Specified by:

getSecurityController in interface IPortalModule

Parameters:

securitySupport - Any IElement that implements ISecuritySupport interface.

Returns:

The ISecurityController object.

Throws:

PortalModuleException - default module exception.

getJMSController

public IJMSController getJMSController()
                                throws PortalModuleException

Description copied from interface: IPortalModule

Gets a JMS controller.

Specified by:

getJMSController in interface IBasePortalModule

Specified by:

getJMSController in interface IPortalModule

Returns:

the IJMSController object.

Throws:

PortalModuleException - default module exception.

getNotificationController

public INotificationController getNotificationController()
                                                  throws PortalModuleException

Description copied from interface: IPortalModule

Get an INotificationController

Specified by:

getNotificationController in interface IBasePortalModule

Specified by:

getNotificationController in interface IPortalModule

Returns:

the INotificationController instance

Throws:

PortalModuleException - default module exception

getAsyncJobQueueController

public IAsyncJobQueueController getAsyncJobQueueController()

Description copied from interface: IPortalModule

Gets an AsyncJobQueue controller.

Specified by:

getAsyncJobQueueController in interface IBasePortalModule

Specified by:

getAsyncJobQueueController in interface IPortalModule

Returns:

the IAsyncJobQueueController object.

getHistoryEventController

public IEventController getHistoryEventController()

Description copied from interface: IPortalModule

Gets a History Event controller.

Specified by:

getHistoryEventController in interface IBasePortalModule

Specified by:

getHistoryEventController in interface IPortalModule

Returns:

the IEventController object.

verifyAuthentication

public boolean verifyAuthentication(String login,
 String password)

Description copied from interface: IPortalModule

Verifies login / password parameters against JAAS.

Specified by:

verifyAuthentication in interface IBasePortalModule

Specified by:

verifyAuthentication in interface IPortalModule

Parameters:

login - The login of the user to verify.

password - The password of the user to verify.

Returns:

true if the parameters are valid, false otherwise.

verifyPassword

public IUser verifyPassword(String login,
 String password)

Description copied from interface: IPortalModule

Allows to verify a password for a specified user login.

Specified by:

verifyPassword in interface IBasePortalModule

Specified by:

verifyPassword in interface IPortalModule

Parameters:

login - The login of the user.

password - The password to verify.

Returns:

A IUser object.

verifyPassword

public IUser verifyPassword(String login,
 String password,
 jakarta.servlet.http.HttpServletRequest request)

Description copied from interface: IPortalModule

Allows to verify a password for a specified user login.

Specified by:

verifyPassword in interface IBasePortalModule

Specified by:

verifyPassword in interface IPortalModule

Parameters:

login - The login of the user.

password - The password to verify.

request - The http Request

Returns:

A IUser object.

getMailingList

public IMailingList getMailingList(IContext context,
 String name,
 int type)
                            throws PortalModuleException

Description copied from interface: IPortalModule

Gets a mailing list by its name.

Specified by:

getMailingList in interface IBasePortalModule

Specified by:

getMailingList in interface IPortalModule

Parameters:

context - the execution context.

name - the name of the IMailingList object.

type - the mailing list type

Returns:

a IMailingList object

Throws:

PortalModuleException - default module exception.

createMailingList

public IMailingList createMailingList(IContext context,
 IOrganization organization,
 String name,
 String label,
 int type)
                               throws PortalModuleException

Description copied from interface: IPortalModule

Creates a new mailing list.

Specified by:

createMailingList in interface IBasePortalModule

Specified by:

createMailingList in interface IPortalModule

Parameters:

context - the execution context.

organization - the IOrganization of the mailing list.

name - the system name of the mailing list.

label - the label of the mailing list.

type - the type of the mailing list.

Returns:

a IMailingList object.

Throws:

PortalModuleException - default module exception.

getMailingLists

public Collection<? extends IMailingList> getMailingLists(IContext context)
                                                   throws PortalModuleException

Description copied from interface: IPortalModule

Gets all mailing lists.

Specified by:

getMailingLists in interface IBasePortalModule

Specified by:

getMailingLists in interface IPortalModule

Parameters:

context - the execution context.

Returns:

a java.util.Collection of IMailingList objects.

Throws:

PortalModuleException - default module exception.

getMailingList

public IMailingList getMailingList(Object object)
                            throws PortalModuleException

Description copied from interface: IPortalModule

Gets a mailing list object from its identifier.

Specified by:

getMailingList in interface IBasePortalModule

Specified by:

getMailingList in interface IPortalModule

Parameters:

object - A object.

Returns:

A IMailingList object.

Throws:

PortalModuleException - default module exception.

getMailingList

public IMailingList getMailingList(IStorageKey key)
                            throws PortalModuleException

Description copied from interface: IPortalModule

Gets a mailing list object from its identifier.

Specified by:

getMailingList in interface IBasePortalModule

Specified by:

getMailingList in interface IPortalModule

Parameters:

key - The key of the mailing list.

Returns:

A IMailingList object.

Throws:

PortalModuleException - default module exception.

send

public void send(jakarta.mail.internet.MimeMessage message)
          throws PortalModuleException

Description copied from interface: IPortalModule

Allows to send a message through the mail agent.

Specified by:

send in interface IBasePortalModule

Specified by:

send in interface IPortalModule

Parameters:

message - The MimeMessage object to send.

Throws:

PortalModuleException - default module exception.

getIndexController

public IIndexController getIndexController(String name)
                                    throws PortalModuleException

Description copied from interface: IPortalModule

Gets the controller of the specified index name.

Specified by:

getIndexController in interface IBasePortalModule

Specified by:

getIndexController in interface IPortalModule

Parameters:

name - The name of the index.

Returns:

A IIndexController object.

Throws:

PortalModuleException - default module exception.

validate

public <T> boolean validate(T value,
 String... rules)

Description copied from interface: IPortalModule

Validate value with validator's rules

Specified by:

validate in interface IBasePortalModule

Specified by:

validate in interface IPortalModule

Parameters:

value - value to validate

rules - rules to apply for validation

Returns:

true if the value is valid, false otherwise.

validate

public <T> boolean validate(Collection<T> values,
 String... rules)

Description copied from interface: IPortalModule

Validate values with validator's rules

Specified by:

validate in interface IBasePortalModule

Specified by:

validate in interface IPortalModule

Parameters:

values - values to validate

rules - rules to apply for validation

Returns:

true if all the values are valid, false otherwise.

getValidatorErrorMessage

public String getValidatorErrorMessage(String rule,
 String language)

Description copied from interface: IPortalModule

Get the validator's error message

Specified by:

getValidatorErrorMessage in interface IBasePortalModule

Specified by:

getValidatorErrorMessage in interface IPortalModule

Parameters:

rule - The validator's name

language - The language

Returns:

the validator's error message, null otherwise

executeTask

public IReport executeTask(Class<?> extensionClass,
 Map<String,String> parameters)
                    throws PortalModuleException

Description copied from interface: IPortalModule

Execute a BaseTaskExtension

Specified by:

executeTask in interface IBasePortalModule

Specified by:

executeTask in interface IPortalModule

Parameters:

extensionClass - class to execute

parameters - parameters sent to the map

Returns:

execution report

Throws:

PortalModuleException - default module exception.

createConnectionDefinition

public IConnectionDefinition<?> createConnectionDefinition(IContext context,
 IOrganization organization,
 String name,
 String label,
 String categoryName)

Description copied from interface: IPortalModule

Create a connection definition

Specified by:

createConnectionDefinition in interface IBasePortalModule

Specified by:

createConnectionDefinition in interface IPortalModule

Parameters:

context - The execution context.

organization - the IOrganization organization of the connection

name - the name of the connection

label - The label of the connection

categoryName - the type of the connection

Returns:

the new connection definition

getConnectionDefinition

public IConnectionDefinition<?> getConnectionDefinition(IContext context,
 String name)
                                                 throws PortalModuleException

Description copied from interface: IPortalModule

Gets a connection from its name.

Specified by:

getConnectionDefinition in interface IBasePortalModule

Specified by:

getConnectionDefinition in interface IPortalModule

Parameters:

context - The execution context.

name - The name of the external reference.

Returns:

a IConnectionDefinition object.

Throws:

PortalModuleException - default module exception.

getConnectionDefinitions

public Collection<? extends IConnectionDefinition<?>> getConnectionDefinitions(IContext context)
                                                                        throws PortalModuleException

Description copied from interface: IPortalModule

Gets a collection of connections.

Specified by:

getConnectionDefinitions in interface IBasePortalModule

Specified by:

getConnectionDefinitions in interface IPortalModule

Parameters:

context - The execution context.

Returns:

a Collection of IConnectionDefinition object.

Throws:

PortalModuleException - default module exception.

verifyToken

public IUser verifyToken(String token)

Description copied from interface: IPortalModule

Verifies authentication token

Specified by:

verifyToken in interface IBasePortalModule

Specified by:

verifyToken in interface IPortalModule

Parameters:

token - the token to verify

Returns:

null if the token is invalid or expired, the matching IUser if the token is valid

getConnectionDefinitionsByTypeName

public Collection<? extends IConnectionDefinition<?>> getConnectionDefinitionsByTypeName(IContext context,
 String type)
                                                                                  throws PortalModuleException

Description copied from interface: IPortalModule

Gets a connection from its name.

Specified by:

getConnectionDefinitionsByTypeName in interface IBasePortalModule

Specified by:

getConnectionDefinitionsByTypeName in interface IPortalModule

Parameters:

context - The execution context.

type - The type of the external reference.

Returns:

a Collection of IConnectionDefinition object.

Throws:

PortalModuleException - default module exception.

getConnectionDefinitionsByCategoryName

public Collection<? extends IConnectionDefinition<?>> getConnectionDefinitionsByCategoryName(IContext context,
 String categoryName)
                                                                                      throws PortalModuleException

Description copied from interface: IPortalModule

Gets a connection from its name.

Specified by:

getConnectionDefinitionsByCategoryName in interface IBasePortalModule

Specified by:

getConnectionDefinitionsByCategoryName in interface IPortalModule

Parameters:

context - The execution context.

categoryName - The categoryName of the external reference.

Returns:

a Collection of IConnectionDefinition object.

Throws:

PortalModuleException - default module exception.

generateSystemName

public String generateSystemName(String label)

Description copied from interface: IModule

Generate a valid system name for this module and this label.

Specified by:

generateSystemName in interface IModule

Parameters:

label - label to normalize

Returns:

normalized value