Package de.fraunhofer.iese.mydata

Interface IMyDataEnvironment

All Known Subinterfaces:

IMyDataEnvironmentFullFace

public interface IMyDataEnvironment

This interface describes the public facade to the MyDataEnvironment, regardless whether you use the Library in LOCAL or CLOUD mode. You can use the IMyDataEnvironment more or less transparent, but you will have to pay special attention when registering PIP/PXP components because they need to be accessible to the PDP. Currently we distinguish three modes in which a service component can be registered to the MyDataEnvironment:

• local: component instance will be registered to the MyDataEnvironment, will be accessible to local PDP and component information will be published to PMP; no need to provide further information like URL. see registerLocalPip(ComponentId, Object)
• managed: component instance will be registered to the MyDataEnvironment, can programmatically be retrieved via getManagedPip(ComponentId)/getManagedPxp(ComponentId) and the corresponding component information is published to the PMP. You are in charge to make the component accessible for the PDP under the specified URL. see registerManagedPip(ComponentId, Object, List)
• unmanaged: component will not be managed by the MyDataEnvironment, only the component information is published to the PMP. You are in charge to make the component accessible for the PDP. see registerUnmanagedPip(PipComponentInformation)

IMyDataEnvironment instances can be created and retrieved by using the MyDataEnvironmentManager

See Also:

MyDataEnvironmentManager

Method Summary

Modifier and Type	Method	Description
<T> T	constructAndRegisterCustomPep(ComponentId componentId, Class<T> interfaceOfPep)	This method generates a custom PEP from the given interface and registers it to the PMP.
<T> T	constructAndRegisterCustomPep(String componentName, Class<T> interfaceOfPep)	This method generates a custom PEP from the given interface and registers it to the PMP.
String	getEnvironmentId()
Optional<IPolicyInformationPoint>	getManagedPip(ComponentId componentId)	Retrieves a previously registered managed Pip instance
Optional<IPolicyExecutionPoint>	getManagedPxp(ComponentId componentId)	Retrieves a previously registered managed Pxp instance
OperationalMode	getOperationalMode()	Access to the instance's OperationalMode
IPolicyEnforcementPoint	getPep()
IBasicManagementService	getPmp()
SolutionId	getSolutionId()	An IMyDataEnvironment instance is always associated with exactly one solution.
java.time.ZoneId	getTimezone()	Get configured timezone for the associated solution
ComponentId	registerLocalPip(ComponentId componentId, Object instance)	Registers a local PipComponent that is managed by the IMyDataEnvironment and is accessible to local PDP.
ComponentId	registerLocalPip(String componentName, Object instance)	Registers a local PipComponent that is managed by the IMyDataEnvironment and is accessible to local PDP.
ComponentId	registerLocalPxp(ComponentId componentId, Object instance)	Registers a local PxpComponent that is managed by the IMyDataEnvironment and is accessible to local PDP.
ComponentId	registerLocalPxp(String componentName, Object instance)	Registers a local PxpComponent that is managed by the IMyDataEnvironment and is accessible to local PDP.
ComponentId	registerManagedPip(ComponentId componentId, Object instance, List<URI> listOfUrl)	Registers a PipComponent that is managed by the IMyDataEnvironment but you are in charge to expose it accessible to the PDP via the specified URL Managed Components can be retrieved from the IMyDataEnvironment; see getManagedPip(ComponentId).
ComponentId	registerManagedPip(String componentName, Object instance, List<URI> listOfUrl)	Registers a PipComponent that is managed by the IMyDataEnvironment but you are in charge to expose it accessible to the PDP via the specified URL Managed Components can be retrieved from the IMyDataEnvironment; see getManagedPip(ComponentId).
ComponentId	registerManagedPxp(ComponentId componentId, Object instance, List<URI> listOfUrl)	Registers a PxpComponent that is managed by the IMyDataEnvironment but you are in charge to expose it accessible to the PDP via the specified URL Managed Components can be retrieved from the IMyDataEnvironment; see getManagedPxp(ComponentId).
ComponentId	registerManagedPxp(String componentName, Object instance, List<URI> listOfUrl)	Registers a PxpComponent that is managed by the IMyDataEnvironment but you are in charge to expose it accessible to the PDP via the specified URL Managed Components can be retrieved from the IMyDataEnvironment; see getManagedPxp(ComponentId).
ComponentId	registerPep(PepComponentInformation pepComponentInformation)	Registers a PepComponent to the IMyDataEnvironment and its encapsulated PMP
ComponentId	registerUnmanagedPip(PipComponentInformation pipComponentInformation)	Registers a remote/external PipComponent that is not managed by the IMyDataEnvironment.
ComponentId	registerUnmanagedPxp(PxpComponentInformation pxpComponentInformation)	Registers a remote/external PxpComponent that is not managed by the IMyDataEnvironment.

Method Detail

getEnvironmentId

String getEnvironmentId()

Returns:

the IMyDataEnvironments environmentId

getSolutionId

SolutionId getSolutionId()

An IMyDataEnvironment instance is always associated with exactly one solution.

Returns:

the solutionId of the solution the IMyDataEnvironment instance is associated with.

getOperationalMode

OperationalMode getOperationalMode()

Access to the instance's OperationalMode

Returns:

the instance's OperationalMode

registerPep

ComponentId registerPep(PepComponentInformation pepComponentInformation)
                 throws IOException,
                        ResourceUpdateException,
                        ConflictingResourceException,
                        InvalidEntityException,
                        NoSuchEntityException

Registers a PepComponent to the IMyDataEnvironment and its encapsulated PMP

Parameters:

pepComponentInformation - the PipComponentInformation

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

registerUnmanagedPip

ComponentId registerUnmanagedPip(PipComponentInformation pipComponentInformation)
                          throws IOException,
                                 ResourceUpdateException,
                                 ConflictingResourceException,
                                 InvalidEntityException,
                                 NoSuchEntityException

Registers a remote/external PipComponent that is not managed by the IMyDataEnvironment.

Parameters:

pipComponentInformation - the PipComponentInformation

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

registerManagedPip

ComponentId registerManagedPip(ComponentId componentId,
                               Object instance,
                               List<URI> listOfUrl)
                        throws InvalidEntityException,
                               ResourceUpdateException,
                               ConflictingResourceException,
                               IOException,
                               NoSuchEntityException

Registers a PipComponent that is managed by the IMyDataEnvironment but you are in charge to expose it accessible to the PDP via the specified URL Managed Components can be retrieved from the IMyDataEnvironment; see getManagedPip(ComponentId).

Parameters:

componentId - the componentId

instance - the instance

listOfUrl - the URL under which you will expose the PipComponent to be used by the PDP.

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

registerManagedPip

ComponentId registerManagedPip(String componentName,
                               Object instance,
                               List<URI> listOfUrl)
                        throws InvalidEntityException,
                               ResourceUpdateException,
                               ConflictingResourceException,
                               IOException,
                               NoSuchEntityException

Registers a PipComponent that is managed by the IMyDataEnvironment but you are in charge to expose it accessible to the PDP via the specified URL Managed Components can be retrieved from the IMyDataEnvironment; see getManagedPip(ComponentId).

Parameters:

componentName - the componentName

instance - the instance

listOfUrl - the URL under which you will expose the PipComponent to be used by the PDP.

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

registerLocalPip

ComponentId registerLocalPip(ComponentId componentId,
                             Object instance)
                      throws IOException,
                             InvalidEntityException,
                             ResourceUpdateException,
                             ConflictingResourceException,
                             NoSuchEntityException

Registers a local PipComponent that is managed by the IMyDataEnvironment and is accessible to local PDP.

Parameters:

componentId - the componentId

instance - the object that should be used as a PipComponent, can implement IPolicyInformationPoint but does not have to.

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

registerLocalPip

ComponentId registerLocalPip(String componentName,
                             Object instance)
                      throws IOException,
                             InvalidEntityException,
                             ResourceUpdateException,
                             ConflictingResourceException,
                             NoSuchEntityException

Registers a local PipComponent that is managed by the IMyDataEnvironment and is accessible to local PDP.

Parameters:

componentName - the componentName

instance - the object that should be used as a PipComponent, can implement IPolicyInformationPoint but does not have to.

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

registerUnmanagedPxp

ComponentId registerUnmanagedPxp(PxpComponentInformation pxpComponentInformation)
                          throws IOException,
                                 ResourceUpdateException,
                                 ConflictingResourceException,
                                 InvalidEntityException,
                                 NoSuchEntityException

Registers a remote/external PxpComponent that is not managed by the IMyDataEnvironment.

Parameters:

pxpComponentInformation - the PxpComponentInformation

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

registerManagedPxp

ComponentId registerManagedPxp(ComponentId componentId,
                               Object instance,
                               List<URI> listOfUrl)
                        throws InvalidEntityException,
                               ResourceUpdateException,
                               ConflictingResourceException,
                               IOException,
                               NoSuchEntityException

Registers a PxpComponent that is managed by the IMyDataEnvironment but you are in charge to expose it accessible to the PDP via the specified URL Managed Components can be retrieved from the IMyDataEnvironment; see getManagedPxp(ComponentId).

Parameters:

componentId - the componentId

instance - the instance

listOfUrl - the URL under which you will expose the PxpComponent to be used by the PDP.

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

registerManagedPxp

ComponentId registerManagedPxp(String componentName,
                               Object instance,
                               List<URI> listOfUrl)
                        throws InvalidEntityException,
                               ResourceUpdateException,
                               ConflictingResourceException,
                               IOException,
                               NoSuchEntityException

Registers a PxpComponent that is managed by the IMyDataEnvironment but you are in charge to expose it accessible to the PDP via the specified URL Managed Components can be retrieved from the IMyDataEnvironment; see getManagedPxp(ComponentId).

Parameters:

componentName - the componentName

instance - the instance

listOfUrl - the URL under which you will expose the PxpComponent to be used by the PDP.

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

registerLocalPxp

ComponentId registerLocalPxp(ComponentId componentId,
                             Object instance)
                      throws IOException,
                             InvalidEntityException,
                             ResourceUpdateException,
                             ConflictingResourceException,
                             NoSuchEntityException

Registers a local PxpComponent that is managed by the IMyDataEnvironment and is accessible to local PDP.

Parameters:

componentId - the componentId

instance - the object that should be used as a PxpComponent, can implement IPolicyExecutionPoint but does not have to.

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

registerLocalPxp

ComponentId registerLocalPxp(String componentName,
                             Object instance)
                      throws IOException,
                             InvalidEntityException,
                             ResourceUpdateException,
                             ConflictingResourceException,
                             NoSuchEntityException

Registers a local PxpComponent that is managed by the IMyDataEnvironment and is accessible to local PDP.

Parameters:

componentName - the componentName

instance - the object that should be used as a PxpComponent, can implement IPolicyExecutionPoint but does not have to.

Returns:

the componentId

Throws:

IOException - communication failure

ConflictingResourceException - the conflicting resource exception

ResourceUpdateException - the resource update exception

InvalidEntityException - the invalid entity exception

NoSuchEntityException

getManagedPip

Optional<IPolicyInformationPoint> getManagedPip(ComponentId componentId)

Retrieves a previously registered managed Pip instance

Parameters:

componentId - the componentId

Returns:

the previously registered managed Pip instance

getManagedPxp

Optional<IPolicyExecutionPoint> getManagedPxp(ComponentId componentId)

Retrieves a previously registered managed Pxp instance

Parameters:

componentId - the componentId

Returns:

the previously registered managed Pxp instance

constructAndRegisterCustomPep

<T> T constructAndRegisterCustomPep(ComponentId componentId,
                                    Class<T> interfaceOfPep)
                             throws InitializationException

This method generates a custom PEP from the given interface and registers it to the PMP. Make sure you call this method at most once per componentId/interface.

Type Parameters:

T - Type of the Interface

Parameters:

componentId - the componentId

interfaceOfPep - The Interface to generate a PEP for.

Returns:

the generated implementation of the custom PEP

Throws:

InitializationException - in case of an error and when there is no PDP available

constructAndRegisterCustomPep

<T> T constructAndRegisterCustomPep(String componentName,
                                    Class<T> interfaceOfPep)
                             throws InitializationException

This method generates a custom PEP from the given interface and registers it to the PMP. Make sure you call this method at most once per componentId/interface.

Type Parameters:

T - Type of the Interface

Parameters:

componentName - the componentName

interfaceOfPep - The Interface to generate a PEP for.

Returns:

the generated implementation of the custom PEP

Throws:

InitializationException - in case of an error and when there is no PDP available

getTimezone

java.time.ZoneId getTimezone()

Get configured timezone for the associated solution

Returns:

the ZoneId that identifies the timezone

getPmp

IBasicManagementService getPmp()

Returns:

the IBasicManagementService for this environment

getPep

IPolicyEnforcementPoint getPep()

Returns:

a DefaultPolicyEnforcementPoint that can be used for enforcement