Class SecureCacheResponse

java.lang.Object
java.net.CacheResponse
java.net.SecureCacheResponse
public abstract class SecureCacheResponse extends CacheResponse
Represents a cache response originally retrieved through secure means, such as TLS.
Since:
1.5

  • Constructor Summary

    Constructors
    Constructor
    Description
    SecureCacheResponse()
    Constructor for subclasses to call.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract String
    getCipherSuite()
    Returns the cipher suite in use on the original connection that retrieved the network resource.
    abstract List<Certificate>
    getLocalCertificateChain()
    Returns the certificate chain that were sent to the server during handshaking of the original connection that retrieved the network resource.
    abstract Principal
    getLocalPrincipal()
    Returns the principal that was sent to the server during handshaking in the original connection that retrieved the network resource.
    abstract Principal
    getPeerPrincipal()
    Returns the server's principal which was established as part of defining the session during the original connection that retrieved the network resource.
    abstract List<Certificate>
    getServerCertificateChain()
    Returns the server's certificate chain, which was established as part of defining the session in the original connection that retrieved the network resource, from cache.
    Optional<SSLSession>
    getSSLSession()
    Returns an Optional containing the SSLSession in use on the original connection that retrieved the network resource.

    Methods declared in class CacheResponse

    getBody, getHeaders
    Modifier and Type
    Method
    Description
    abstract InputStream
    getBody()
    Returns the response body as an InputStream.
    abstract Map<String, List<String>>
    getHeaders()
    Returns the response headers as a Map.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • SecureCacheResponse

      public SecureCacheResponse()
      Constructor for subclasses to call.

  • Method Details

    • getCipherSuite

      public abstract String getCipherSuite()
      Returns the cipher suite in use on the original connection that retrieved the network resource.
      Returns:
      a string representing the cipher suite

    • getLocalCertificateChain

      public abstract List<Certificate> getLocalCertificateChain()
      Returns the certificate chain that were sent to the server during handshaking of the original connection that retrieved the network resource. Note: This method is useful only when using certificate-based cipher suites.
      Returns:
      an immutable List of Certificate representing the certificate chain that was sent to the server. If no certificate chain was sent, null will be returned.
      See Also:

    • getServerCertificateChain

      public abstract List<Certificate> getServerCertificateChain() throws SSLPeerUnverifiedException
      Returns the server's certificate chain, which was established as part of defining the session in the original connection that retrieved the network resource, from cache. Note: This method can be used only when using certificate-based cipher suites; using it with non-certificate-based cipher suites, such as Kerberos, will throw an SSLPeerUnverifiedException.
      Returns:
      an immutable List of Certificate representing the server's certificate chain.
      Throws:
      SSLPeerUnverifiedException - if the peer is not verified.
      See Also:

    • getPeerPrincipal

      public abstract Principal getPeerPrincipal() throws SSLPeerUnverifiedException
      Returns the server's principal which was established as part of defining the session during the original connection that retrieved the network resource.
      Returns:
      the server's principal. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites.
      Throws:
      SSLPeerUnverifiedException - if the peer was not verified.
      See Also:

    • getLocalPrincipal

      public abstract Principal getLocalPrincipal()
      Returns the principal that was sent to the server during handshaking in the original connection that retrieved the network resource.
      Returns:
      the principal sent to the server. Returns an X500Principal of the end-entity certificate for X509-based cipher suites, and KerberosPrincipal for Kerberos cipher suites. If no principal was sent, then null is returned.
      See Also:

    • getSSLSession

      public Optional<SSLSession> getSSLSession()
      Returns an Optional containing the SSLSession in use on the original connection that retrieved the network resource. Returns an empty Optional if the underlying implementation does not support this method.
      Implementation Requirements:
      For compatibility, the default implementation of this method returns an empty Optional. Subclasses should override this method with an appropriate implementation since an application may need to access additional parameters associated with the SSL session.
      Returns:
      an Optional containing the SSLSession in use on the original connection
      Since:
      12
      See Also: