org.opensaml.ws.transport

Interface Transport

All Known Subinterfaces:

HTTPInTransport, HTTPOutTransport, HTTPTransport, InTransport, OutTransport

All Known Implementing Classes:

BaseTransport, HttpServletRequestAdapter, HttpServletResponseAdapter, InputStreamInTransportAdapter, OutputStreamOutTransportAdapter

public interface Transport

Base interface for inbound and outbound transports.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String name) Gets a transport-specific attribute.
String	getCharacterEncoding() Gets the character encoding of the transport.
Credential	getLocalCredential() Gets the local credential used to authenticate to the peer.
Credential	getPeerCredential() Gets the credential offered by the peer to authenticate itself.
boolean	isAuthenticated() Gets whether the peer is authenticated.
boolean	isConfidential() Gets whether the transport represents a confidential connection (e.g.
boolean	isIntegrityProtected() Gets whether the transport represents a connection that protects the integrity of transported content.
void	setAuthenticated(boolean isAuthenticated) Sets whether the peer is authenticated.
void	setConfidential(boolean isConfidential) Sets whether the transport represents a confidential connection.
void	setIntegrityProtected(boolean isIntegrityProtected) Sets whether the transport represents a connection that protects the integrity of transported content.

Method Detail

getAttribute

Object getAttribute(String name)

Gets a transport-specific attribute.

Parameters:

name - name of the attribute

Returns:

attribute value

getCharacterEncoding

String getCharacterEncoding()

Gets the character encoding of the transport.

Returns:

character encoding of the transport

getLocalCredential

Credential getLocalCredential()

Gets the local credential used to authenticate to the peer.

Returns:

local credential used to authenticate to the peer

getPeerCredential

Credential getPeerCredential()

Gets the credential offered by the peer to authenticate itself.

Returns:

credential offered by the peer to authenticate itself

isAuthenticated

boolean isAuthenticated()

Gets whether the peer is authenticated.

Returns:

whether the peer is authenticated

setAuthenticated

void setAuthenticated(boolean isAuthenticated)

Sets whether the peer is authenticated.

Parameters:

isAuthenticated - whether the peer is authenticated

isConfidential

boolean isConfidential()

Gets whether the transport represents a confidential connection (e.g. an SSL connection).

Returns:

whether the transport represents a confidential connection

setConfidential

void setConfidential(boolean isConfidential)

Sets whether the transport represents a confidential connection.

Parameters:

isConfidential - whether the transport represents a confidential connection

isIntegrityProtected

boolean isIntegrityProtected()

Gets whether the transport represents a connection that protects the integrity of transported content.

Returns:

whether the transport represents a connection that protects the integrity of transported content

setIntegrityProtected

void setIntegrityProtected(boolean isIntegrityProtected)

Sets whether the transport represents a connection that protects the integrity of transported content.

Parameters:

isIntegrityProtected - whether the transport represents a connection that protects the integrity of transported content