Package pl.edu.icm.unity.engine.api

Interface EndpointManagement

  • public interface EndpointManagement
    Management of endpoints
    Author:
    K. Benedyczak

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      pl.edu.icm.unity.types.endpoint.ResolvedEndpoint deploy​(java.lang.String typeId, java.lang.String endpointName, java.lang.String address, pl.edu.icm.unity.types.endpoint.EndpointConfiguration configuration)
      Deploys a new instance of an endpoint of id type, at address location.
      java.util.List<pl.edu.icm.unity.types.endpoint.ResolvedEndpoint> getDeployedEndpoints()  
      pl.edu.icm.unity.types.endpoint.Endpoint getEndpoint​(java.lang.String name)  
      java.util.List<pl.edu.icm.unity.types.endpoint.Endpoint> getEndpoints()  
      java.util.List<pl.edu.icm.unity.types.endpoint.EndpointTypeDescription> getEndpointTypes()  
      void removeEndpoint​(java.lang.String id)
      Removes endpoint with given name
      void undeploy​(java.lang.String id)
      Removes a deployed endpoint
      void updateEndpoint​(java.lang.String id, pl.edu.icm.unity.types.endpoint.EndpointConfiguration configuration)
      Updates a deployed endpoint configuration

    • Method Detail

      • getEndpointTypes

        java.util.List<pl.edu.icm.unity.types.endpoint.EndpointTypeDescription> getEndpointTypes()
                                                                                  throws pl.edu.icm.unity.exceptions.EngineException
        Returns:
        available endpoint types
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getDeployedEndpoints

        java.util.List<pl.edu.icm.unity.types.endpoint.ResolvedEndpoint> getDeployedEndpoints()
                                                                               throws pl.edu.icm.unity.exceptions.EngineException
        Returns:
        list of deployed endpoints
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • deploy

        pl.edu.icm.unity.types.endpoint.ResolvedEndpoint deploy​(java.lang.String typeId,
                                                        java.lang.String endpointName,
                                                        java.lang.String address,
                                                        pl.edu.icm.unity.types.endpoint.EndpointConfiguration configuration)
                                                 throws pl.edu.icm.unity.exceptions.EngineException
        Deploys a new instance of an endpoint of id type, at address location. Address is a path in web app context for the servlet endpoints.
        Parameters:
        typeId -
        endpointName - identifier to be given to the endpoint
        address -
        configuration -
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • undeploy

        void undeploy​(java.lang.String id)
       throws pl.edu.icm.unity.exceptions.EngineException
        Removes a deployed endpoint
        Parameters:
        id - endpoint instance id.
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • updateEndpoint

        void updateEndpoint​(java.lang.String id,
                    pl.edu.icm.unity.types.endpoint.EndpointConfiguration configuration)
             throws pl.edu.icm.unity.exceptions.EngineException
        Updates a deployed endpoint configuration
        Parameters:
        id - mandatory id of a deployed endpoint
        configuration - updated configuration, can have null elements to leave the existing values unchanged.
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getEndpoints

        java.util.List<pl.edu.icm.unity.types.endpoint.Endpoint> getEndpoints()
                                                               throws pl.edu.icm.unity.exceptions.AuthorizationException
        Returns:
        all endpoints from db
        Throws:
        pl.edu.icm.unity.exceptions.AuthorizationException

      • removeEndpoint

        void removeEndpoint​(java.lang.String id)
             throws pl.edu.icm.unity.exceptions.EngineException
        Removes endpoint with given name
        Parameters:
        id - mandatory id of removed endpoint
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getEndpoint

        pl.edu.icm.unity.types.endpoint.Endpoint getEndpoint​(java.lang.String name)
                                              throws pl.edu.icm.unity.exceptions.AuthorizationException
        Parameters:
        name - endpoint name
        Returns:
        Throws:
        pl.edu.icm.unity.exceptions.AuthorizationException