Packages

object SSLHelper

Static utilities for creating SSL Contexts to serve the API via HTTPS. Pre-requisites:

  • A valid certificate is expected to be found in a keystore.
  • Some environment variables need to be set beforehand:
    • KEYSTORE_PATH: location of the keystore storing the certificate.
    • KEYSTORE_PASSWORD: password protecting the keystore (leave empty if there is none).
    • KEYMANAGER_PASSWORD: password protecting the certificate (leave empty is there is none).
Note

The inner functionality needs to be able read the host's environment and filesystem

,

Further docs, see https://github.com/weso/rdfshape-api/wiki/Deploying-RDFShape-API-(SBT)#serving-with-https

See also

es.weso.rdfshape.server.Server

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SSLHelper
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def getContext: SSLContext

    Try to build an SSL Context given that the certificate's location and credentials are in the PATH.

    Try to build an SSL Context given that the certificate's location and credentials are in the PATH.

    returns

    An SSLContext created from the user's certificate

    Annotations
    @throws(classOf[SSLContextCreationException]) @throws(classOf[IOException])
    Exceptions thrown

    es.weso.rdfshape.server.utils.error.exceptions.SSLContextCreationException On errors getting the certificate information

    java.io.IOException On errors accessing the filesystem

  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. lazy val keyManagerPassword: Option[String]

    Password protecting the certificate, extracted from the host's environment.

  13. lazy val keyStorePassword: Option[String]

    Password protecting the keystore, extracted from the host's environment.

  14. lazy val keyStorePath: Option[String]

    Location of the keystore storing the certificate, extracted from the host's environment.

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped