org.alfresco.bm.user

Class InviteUser

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.http.AuthenticatedHttpEventProcessor

org.alfresco.bm.user.InviteUser

All Implemented Interfaces:

org.alfresco.bm.event.EventProcessor, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class InviteUser
extends org.alfresco.bm.http.AuthenticatedHttpEventProcessor

Process an Alfresco Cloud invite.

Input

User email address.

Data

A MongoDB collection containing the details of the user matching the input email address.

Actions

Fetches the user data from the MongoDB using the inbound email address. Registers the user in the sign-up queue. Stores the sign-up details.

Output

EVENT_NAME_USER_INVITED: The user's email address

Since:

1.0

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_API_SIGNUP_QUEUE
static long	DEFAULT_MAX_ACCEPT_TIME
static long	DEFAULT_MIN_ACCEPT_TIME
static String	EVENT_NAME_USER_INVITED

Fields inherited from class org.alfresco.bm.event.AbstractEventProcessor

DEFAULT_CHART, DEFAULT_PROPAGATE_SESSION_ID, DEFAULT_WARN_DELAY, logger

Constructor Summary

Constructors

Constructor and Description
InviteUser(org.alfresco.http.HttpClientProvider httpClientProvider, org.alfresco.http.AuthenticationDetailsProvider authenticationDetailsProvider, String baseUrl, org.alfresco.bm.user.UserDataService userDataService)

Method Summary

Methods

Modifier and Type	Method and Description
org.alfresco.bm.event.EventResult	processEvent(org.alfresco.bm.event.Event event)
void	setApiSignupQueue(String apiSignupQueue) Override the default URL part to the signup queue api.
void	setEventNameUserInvited(String eventNameUserInvited) Override the default event name for 'user invited'.
void	setLayer7Key(String layer7Key) Optionally set the gateway 'key' header value.
void	setMaxAcceptTime(long maxAcceptTime) Override the default maximum time for the user to accept the invite.
void	setMinAcceptTime(long minAcceptTime) Override the default minimum time for the user to accept the invite.

Methods inherited from class org.alfresco.bm.http.AuthenticatedHttpEventProcessor

executeHttpMethodAsAdmin, executeHttpMethodAsUser, getAuthDetailProvider, getFullUrlForPath, getHttpProvider, releaseResources, setTicketBasedAuthentication

Methods inherited from class org.alfresco.bm.event.AbstractEventProcessor

getWarnDelay, isChart, processEvent, propagateSessionId, register, resumeTimer, setBeanName, setChart, setEventName, setEventNames, setPropagateSessionId, setRegistry, setWarnDelay, stopTimer, suspendTimer, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MIN_ACCEPT_TIME

public static final long DEFAULT_MIN_ACCEPT_TIME

See Also:

Constant Field Values

DEFAULT_MAX_ACCEPT_TIME

public static final long DEFAULT_MAX_ACCEPT_TIME

See Also:

Constant Field Values

DEFAULT_API_SIGNUP_QUEUE

public static final String DEFAULT_API_SIGNUP_QUEUE

See Also:

Constant Field Values

EVENT_NAME_USER_INVITED

public static final String EVENT_NAME_USER_INVITED

See Also:

Constant Field Values

Constructor Detail

InviteUser

public InviteUser(org.alfresco.http.HttpClientProvider httpClientProvider,
          org.alfresco.http.AuthenticationDetailsProvider authenticationDetailsProvider,
          String baseUrl,
          org.alfresco.bm.user.UserDataService userDataService)

Parameters:

httpClientProvider - common provider for HTTP connections

authenticationDetailsProvider - common provider of username-passwords

baseUrl - the base Alfresco URL for fetching tickets

userDataService - service handling user details

Method Detail

setApiSignupQueue

public void setApiSignupQueue(String apiSignupQueue)

Override the default URL part to the signup queue api.

setLayer7Key

public void setLayer7Key(String layer7Key)

Optionally set the gateway 'key' header value. If this is null or empty then the value will not be set, implying that the APIs are only protected by basic authentication.

Parameters:

layer7Key - a secret key; null or empty string to ignore

setMinAcceptTime

public void setMinAcceptTime(long minAcceptTime)

Override the default minimum time for the user to accept the invite.

setMaxAcceptTime

public void setMaxAcceptTime(long maxAcceptTime)

Override the default maximum time for the user to accept the invite.

setEventNameUserInvited

public void setEventNameUserInvited(String eventNameUserInvited)

Override the default event name for 'user invited'.

processEvent

public org.alfresco.bm.event.EventResult processEvent(org.alfresco.bm.event.Event event)
                                               throws Exception

Specified by:

processEvent in class org.alfresco.bm.event.AbstractEventProcessor

Throws:

Exception