org.da.protoframework.util

Class OptionalServicesConfigurator

java.lang.Object

org.da.protoframework.util.OptionalServicesConfigurator

public class OptionalServicesConfigurator
extends java.lang.Object

This class check the presence of the optional services.

Constructor Summary

Constructors

Constructor and Description
OptionalServicesConfigurator(Module module, java.net.URL servicesURL, java.net.URL typesURL) Constructor.
OptionalServicesConfigurator(Module module, java.net.URL servicesURL, java.net.URL typesURL, boolean isStrict) Constructor.

Method Summary

Modifier and Type	Method and Description
NamespaceKey	addService(NamespaceKey key, boolean isProvider) Add a Service to check.
NamespaceKey	addService(NamespaceKey key, boolean isProvider, boolean isStrict) Add a Service to check.
NamespaceKey	addService(java.lang.String name, boolean isProvider) Add a Service to check.
NamespaceKey	addService(java.lang.String name, boolean isProvider, boolean isStrict) Add a Service to check.
NamespaceKey	addService(java.lang.String uri, java.lang.String name, boolean isProvider) Add a Service to check.
NamespaceKey	addService(java.lang.String uri, java.lang.String name, boolean isProvider, boolean isStrict) Add a Service to check.
ServiceInstance<?,?>	getService(NamespaceKey key) Return a checked Service.
ServiceInstance<?,?>	getService(java.lang.String name) Return a checked Service.
ServiceInstance<?,?>	getService(java.lang.String uri, java.lang.String name) Return a Service.
boolean	isOptionalService(NamespaceKey key) Return true is a Service is in the map of checked services.
boolean	isSilent() Return true if the errors should not be redirected.
void	setSilent(boolean isSilent) Set if the errors should not be redirected.
void	setup() Setup the configurator.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalServicesConfigurator

public OptionalServicesConfigurator(Module module,
                                    java.net.URL servicesURL,
                                    java.net.URL typesURL)

Constructor.

Parameters:

module - the module

servicesURL - the reference services URL

typesURL - the reference types URL

OptionalServicesConfigurator

public OptionalServicesConfigurator(Module module,
                                    java.net.URL servicesURL,
                                    java.net.URL typesURL,
                                    boolean isStrict)

Constructor.

Parameters:

module - the module

servicesURL - the reference services URL

typesURL - the reference types URL

isStrict - true if it is not allowed to have provided datas in the template which are not found in the definition

Method Detail

setSilent

public void setSilent(boolean isSilent)

Set if the errors should not be redirected.

Parameters:

isSilent - true if the errors should not be redirected

isSilent

public boolean isSilent()

Return true if the errors should not be redirected.

Returns:

true if the errors should not be redirected

addService

public NamespaceKey addService(java.lang.String name,
                               boolean isProvider)

Add a Service to check.

Parameters:

name - the service name

isProvider - true if the service must be a provider

Returns:

the service

addService

public NamespaceKey addService(java.lang.String name,
                               boolean isProvider,
                               boolean isStrict)

Add a Service to check.

Parameters:

name - the service name

isProvider - true if the service must be a provider

isStrict - true if it is allowed to have provided datas in the template which are not found in the definition

Returns:

the service

addService

public NamespaceKey addService(java.lang.String uri,
                               java.lang.String name,
                               boolean isProvider)

Add a Service to check.

Parameters:

uri - the service uri

name - the service name

isProvider - true if the service must be a provider

Returns:

the service

addService

public NamespaceKey addService(java.lang.String uri,
                               java.lang.String name,
                               boolean isProvider,
                               boolean isStrict)

Add a Service to check.

Parameters:

uri - the service uri

name - the service name

isProvider - true if the service must be a provider

isStrict - true if it is allowed to have provided datas in the template which are not found in the definition

Returns:

the service

addService

public NamespaceKey addService(NamespaceKey key,
                               boolean isProvider)

Add a Service to check.

Parameters:

key - the service key

isProvider - true if the service must be a provider

Returns:

the service

addService

public NamespaceKey addService(NamespaceKey key,
                               boolean isProvider,
                               boolean isStrict)

Add a Service to check.

Parameters:

key - the service key

isProvider - true if the service must be a provider

isStrict - true if it is allowed to have provided datas in the template which are not found in the definition

Returns:

the service

getService

public ServiceInstance<?,?> getService(java.lang.String name)

Return a checked Service.

Parameters:

name - the Service name

Returns:

the Service

getService

public ServiceInstance<?,?> getService(java.lang.String uri,
                                       java.lang.String name)

Return a Service.

Parameters:

uri - the service uri

name - the Service name

Returns:

the Service

getService

public ServiceInstance<?,?> getService(NamespaceKey key)

Return a checked Service.

Parameters:

key - the service key

Returns:

the Service

isOptionalService

public boolean isOptionalService(NamespaceKey key)

Return true is a Service is in the map of checked services. It means that this Service was added to addService(org.da.protoframework.model.namespace.NamespaceKey, boolean).

Parameters:

key - the Service key

Returns:

true is a Service is in the map of checked services

setup

public void setup()

Setup the configurator. This must be called before calling the getService(java.lang.String) method and other associated methods.