Package de.iip_ecosphere.platform.support.aas.basyx

Class BaSyxDeploymentRecipe

  • All Implemented Interfaces:
    de.iip_ecosphere.platform.support.aas.DeploymentRecipe
    public class BaSyxDeploymentRecipe
extends java.lang.Object
implements de.iip_ecosphere.platform.support.aas.DeploymentRecipe
    An initial BaSyx-specific deployment builder.
    Author:
    Holger Eichelberger, SSE

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      private class  BaSyxDeploymentRecipe.BaSyxImmediateDeploymentRecipe
      Implements the immediate deployment recipe.
      private class  BaSyxDeploymentRecipe.BaSyxRegistryDeploymentRecipe
      Implements the registry deployment recipe.

      • Nested classes/interfaces inherited from interface de.iip_ecosphere.platform.support.aas.DeploymentRecipe

        de.iip_ecosphere.platform.support.aas.DeploymentRecipe.ImmediateDeploymentRecipe, de.iip_ecosphere.platform.support.aas.DeploymentRecipe.RegistryDeploymentRecipe

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private DeploymentSpec deploymentSpec  

      • Fields inherited from interface de.iip_ecosphere.platform.support.aas.DeploymentRecipe

        ANY_CORS_ORIGIN

    • Constructor Summary

      Constructors 
      Constructor Description
      BaSyxDeploymentRecipe​(de.iip_ecosphere.platform.support.Endpoint endpoint)
      Creates a deployment builder with root/empty document base path.
      BaSyxDeploymentRecipe​(de.iip_ecosphere.platform.support.Endpoint endpoint, de.iip_ecosphere.platform.support.net.KeyStoreDescriptor kstore)
      Creates a deployment builder with root/empty document base path.
      BaSyxDeploymentRecipe​(java.lang.String host, int port, java.lang.String contextPath, java.lang.String docBasePath)
      Creates a deployment builder.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      de.iip_ecosphere.platform.support.aas.DeploymentRecipe.ImmediateDeploymentRecipe addInMemoryRegistry​(de.iip_ecosphere.platform.support.Endpoint regEndpoint)  
      de.iip_ecosphere.platform.support.aas.DeploymentRecipe.ImmediateDeploymentRecipe addInMemoryRegistry​(java.lang.String regEndpoint)  
      (package private) static void deploy​(DeploymentSpec deploymentSpec, de.iip_ecosphere.platform.support.aas.Aas aas)
      Creates a new BaSyx AAS server.
      de.iip_ecosphere.platform.support.aas.DeploymentRecipe setAccessControlAllowOrigin​(java.lang.String accessControlAllowOrigin)  
      de.iip_ecosphere.platform.support.aas.DeploymentRecipe setBearerTokenAuthenticationConfiguration​(java.lang.String issuerUri, java.lang.String jwkSetUri, java.lang.String requiredAud)  
      de.iip_ecosphere.platform.support.aas.DeploymentRecipe.RegistryDeploymentRecipe setRegistryUrl​(de.iip_ecosphere.platform.support.Endpoint endpoint)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BaSyxDeploymentRecipe

        BaSyxDeploymentRecipe​(de.iip_ecosphere.platform.support.Endpoint endpoint)
        Creates a deployment builder with root/empty document base path.
        Parameters:
        endpoint - the endpoint to create the deployment context for

      • BaSyxDeploymentRecipe

        BaSyxDeploymentRecipe​(de.iip_ecosphere.platform.support.Endpoint endpoint,
                      de.iip_ecosphere.platform.support.net.KeyStoreDescriptor kstore)
        Creates a deployment builder with root/empty document base path.
        Parameters:
        endpoint - the endpoint to create the deployment context for
        kstore - the key store descriptor, ignored if null

      • BaSyxDeploymentRecipe

        BaSyxDeploymentRecipe​(java.lang.String host,
                      int port,
                      java.lang.String contextPath,
                      java.lang.String docBasePath)
        Creates a deployment builder.
        Parameters:
        host - the target host
        port - the target IP port
        contextPath - the context base path (may be empty, otherwise shall start with a "/")
        docBasePath - the documents base path (may be empty, otherwise shall start with a "/")

    • Method Detail

      • setAccessControlAllowOrigin

        public de.iip_ecosphere.platform.support.aas.DeploymentRecipe setAccessControlAllowOrigin​(java.lang.String accessControlAllowOrigin)
        Specified by:
        setAccessControlAllowOrigin in interface de.iip_ecosphere.platform.support.aas.DeploymentRecipe

      • setBearerTokenAuthenticationConfiguration

        public de.iip_ecosphere.platform.support.aas.DeploymentRecipe setBearerTokenAuthenticationConfiguration​(java.lang.String issuerUri,
                                                                                                        java.lang.String jwkSetUri,
                                                                                                        java.lang.String requiredAud)
                                                                                                 throws java.lang.IllegalArgumentException
        Specified by:
        setBearerTokenAuthenticationConfiguration in interface de.iip_ecosphere.platform.support.aas.DeploymentRecipe
        Throws:
        java.lang.IllegalArgumentException

      • addInMemoryRegistry

        public de.iip_ecosphere.platform.support.aas.DeploymentRecipe.ImmediateDeploymentRecipe addInMemoryRegistry​(de.iip_ecosphere.platform.support.Endpoint regEndpoint)
        Specified by:
        addInMemoryRegistry in interface de.iip_ecosphere.platform.support.aas.DeploymentRecipe

      • addInMemoryRegistry

        public de.iip_ecosphere.platform.support.aas.DeploymentRecipe.ImmediateDeploymentRecipe addInMemoryRegistry​(java.lang.String regEndpoint)
        Specified by:
        addInMemoryRegistry in interface de.iip_ecosphere.platform.support.aas.DeploymentRecipe

      • setRegistryUrl

        public de.iip_ecosphere.platform.support.aas.DeploymentRecipe.RegistryDeploymentRecipe setRegistryUrl​(de.iip_ecosphere.platform.support.Endpoint endpoint)
        Specified by:
        setRegistryUrl in interface de.iip_ecosphere.platform.support.aas.DeploymentRecipe

      • deploy

        static void deploy​(DeploymentSpec deploymentSpec,
                   de.iip_ecosphere.platform.support.aas.Aas aas)
        Creates a new BaSyx AAS server.
        Parameters:
        deploymentSpec - the deployment set instance
        aas - the AAS