Package org.silverpeas.core.subscription

Class SubscriptionFactory

java.lang.Object

org.silverpeas.core.subscription.SubscriptionFactory

@Provider
@Singleton
public class SubscriptionFactory
extends Object

Register of all subscription resource type available into Silverpeas.

By default, all CommonSubscriptionResourceConstants constants are registered.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SubscriptionFactory.SubscriptionConstructor<R extends SubscriptionResource>
static interface	SubscriptionFactory.SubscriptionResourceConstructor

Method Summary

Modifier and Type	Method	Description
<R extends SubscriptionResource> AbstractSubscription<R>	createSubscriptionInstance(SubscriptionSubscriber subscriber, R resource, String creatorId)	Creates a Subscription instance from given data.
SubscriptionResource	createSubscriptionResourceInstance(SubscriptionResourceType type, String resourceId, String space, String instanceId)	Creates a SubscriptionResource instance from given data.
static SubscriptionFactory	get()
SubscriptionResourceType	getSubscriptionResourceTypeByName(String name)	Gets a registered subscription type by its name if any.
void	register(SubscriptionResourceType type, SubscriptionFactory.SubscriptionResourceConstructor srConstructor, SubscriptionFactory.SubscriptionConstructor sConstructor)	Adds a SubscriptionResourceType instance.
protected void	setupDefaults()
Stream<SubscriptionResourceType>	streamAll()	Gets all registered subscription resource types.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static SubscriptionFactory get()

setupDefaults

@PostConstruct
protected void setupDefaults()

register

public void register(SubscriptionResourceType type,
                     SubscriptionFactory.SubscriptionResourceConstructor srConstructor,
                     SubscriptionFactory.SubscriptionConstructor sConstructor)

Adds a SubscriptionResourceType instance.

Only valid instance are registered.

Parameters:

type - a subscription resource type to add.

srConstructor - a constructor of SubscriptionResource of type SubscriptionResourceType.

sConstructor - a constructor of Subscription of a SubscriptionResource.

getSubscriptionResourceTypeByName

public SubscriptionResourceType getSubscriptionResourceTypeByName(String name)

Gets a registered subscription type by its name if any.

Parameters:

name - the name of a subscription type.

Returns:

the corresponding SubscriptionResourceType instance if any, CommonSubscriptionResourceConstants.UNKNOWN otherwise.

createSubscriptionResourceInstance

public SubscriptionResource createSubscriptionResourceInstance(SubscriptionResourceType type,
                                                               String resourceId,
                                                               String space,
                                                               String instanceId)

Creates a SubscriptionResource instance from given data.

Parameters:

type - a SubscriptionResourceType instance.

resourceId - an identifier of resource (the local one)

space - a space reference into which the resource is handled (legacy management).

instanceId - an identifier of a component instance into which the resource is hosted.

Returns:

an initialized SubscriptionResource instance.

createSubscriptionInstance

public <R extends SubscriptionResource> AbstractSubscription<R> createSubscriptionInstance(SubscriptionSubscriber subscriber,
                                                                                           R resource,
                                                                                           String creatorId)

Creates a Subscription instance from given data.

Parameters:

subscriber - a SubscriptionSubscriber instance.

resource - a SubscriptionResource instance.

creatorId - the user id that has handled the subscription.

Returns:

an initialized Subscription instance.

streamAll

public Stream<SubscriptionResourceType> streamAll()

Gets all registered subscription resource types.

Data are sorted first by SubscriptionResourceType.priority() then by SubscriptionResourceType.getName().

Returns:

a stream of registered subscription resource type.