org.opensaml.ws.transport
Class BaseTransport

java.lang.Object
  extended by org.opensaml.ws.transport.BaseTransport
All Implemented Interfaces:
Transport
Direct Known Subclasses:
InputStreamInTransportAdapter, OutputStreamOutTransportAdapter

public abstract class BaseTransport
extends Object
implements Transport

Base abstract class for a Transport that provides local storage for all transport properties.


Constructor Summary
BaseTransport()
          Constructor.
 
Method Summary
 Object getAttribute(String name)
          Gets a transport-specific attribute.
 String getCharacterEncoding()
          Gets the character encoding of the transport.
 org.opensaml.xml.security.credential.Credential getLocalCredential()
          Gets the local credential used to authenticate to the peer.
 org.opensaml.xml.security.credential.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.
protected  void setAttribute(String name, Object value)
          Set an attribute value.
 void setAuthenticated(boolean isAuthenticated)
          Sets whether the peer is authenticated.
protected  void setCharacterEncoding(String encoding)
          Set the character encoding.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseTransport

public BaseTransport()
Constructor.

Method Detail

getAttribute

public Object getAttribute(String name)
Gets a transport-specific attribute.

Specified by:
getAttribute in interface Transport
Parameters:
name - name of the attribute
Returns:
attribute value

getCharacterEncoding

public String getCharacterEncoding()
Gets the character encoding of the transport.

Specified by:
getCharacterEncoding in interface Transport
Returns:
character encoding of the transport

getLocalCredential

public org.opensaml.xml.security.credential.Credential getLocalCredential()
Gets the local credential used to authenticate to the peer.

Specified by:
getLocalCredential in interface Transport
Returns:
local credential used to authenticate to the peer

getPeerCredential

public org.opensaml.xml.security.credential.Credential getPeerCredential()
Gets the credential offered by the peer to authenticate itself.

Specified by:
getPeerCredential in interface Transport
Returns:
credential offered by the peer to authenticate itself

isAuthenticated

public boolean isAuthenticated()
Gets whether the peer is authenticated.

Specified by:
isAuthenticated in interface Transport
Returns:
whether the peer is authenticated

isConfidential

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

Specified by:
isConfidential in interface Transport
Returns:
whether the transport represents a confidential connection

isIntegrityProtected

public boolean isIntegrityProtected()
Gets whether the transport represents a connection that protects the integrity of transported content.

Specified by:
isIntegrityProtected in interface Transport
Returns:
whether the transport represents a connection that protects the integrity of transported content

setAuthenticated

public void setAuthenticated(boolean isAuthenticated)
Sets whether the peer is authenticated.

Specified by:
setAuthenticated in interface Transport
Parameters:
isAuthenticated - whether the peer is authenticated

setConfidential

public void setConfidential(boolean isConfidential)
Sets whether the transport represents a confidential connection.

Specified by:
setConfidential in interface Transport
Parameters:
isConfidential - whether the transport represents a confidential connection

setIntegrityProtected

public void setIntegrityProtected(boolean isIntegrityProtected)
Sets whether the transport represents a connection that protects the integrity of transported content.

Specified by:
setIntegrityProtected in interface Transport
Parameters:
isIntegrityProtected - whether the transport represents a connection that protects the integrity of transported content

setAttribute

protected void setAttribute(String name,
                            Object value)
Set an attribute value.

Parameters:
name - attribute name
value - attribute value

setCharacterEncoding

protected void setCharacterEncoding(String encoding)
Set the character encoding.

Parameters:
encoding - the character encoding


Copyright © 2006-2013 Internet2. All Rights Reserved.