PAOSHeader (OpenSSO Public API)

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.sun.identity.liberty.ws.paos
クラス PAOSHeader

java.lang.Object
  com.sun.identity.liberty.ws.paos.PAOSHeader

public class PAOSHeader
extends Object
extends Object

The PAOSHeader class is used by a web application on HTTP server side to parse a PAOS header in an HTTP request from the user agent side. This header is used by the User Agent as a PAOS server to publish which services are available, which PAOS versions are supported, etc.. An example PAOS header looks like the following:

 PAOS: ver="ver1","ver2",ext="ext1","ext2";"service1","opt11",
           "opt12";"service2","opt21","opt22"

This class has methods for obtaining all the parts inside such a header.

コンストラクタの概要
`PAOSHeader(HttpServletRequest req)` This constructor accepts an `HttpServletRequest` and tries to parse the `PAOS` header string if there is one inside.
`PAOSHeader(String paosHeaderString)` This constructor accepts a `PAOS` header string and tries to parse it.

メソッドの概要
`Iterator`	`getExtensions()` Returns the list of extensions as `String`s.
`HashMap`	`getServicesAndOptions()` Returns a `HashMap` containing the services and corresponding options.
`Iterator`	`getVersions()` Returns the list of versions as `String`s.

コンストラクタの詳細

PAOSHeader

public PAOSHeader(HttpServletRequest req)
           throws PAOSException

This constructor accepts an HttpServletRequest and tries to parse the PAOS header string if there is one inside.

パラメータ:: req - the incoming HTTP request which is supposed to contain the PAOS header.
例外:: PAOSException - if there are any parsing errors because the PAOS header is not there at all or because its content is not compliant to the PAOS specifications.

PAOSHeader

public PAOSHeader(String paosHeaderString)
           throws PAOSException

This constructor accepts a PAOS header string and tries to parse it.

パラメータ:: paosHeaderString - the PAOS header string which supposedly contains information on available services, etc..
例外:: PAOSException - if there are any parsing error because the PAOS header is invalid.

メソッドの詳細

getVersions

public Iterator getVersions()

Returns the list of versions as Strings.

戻り値:: the list of versions as Strings.

getExtensions

public Iterator getExtensions()

Returns the list of extensions as Strings.

戻り値:: the list of extensions as Strings.

getServicesAndOptions

public HashMap getServicesAndOptions()

Returns a HashMap containing the services and corresponding options.

戻り値:: a HashMap with each key being a service represented as a String, and with each value being a Set of the corresponding options represented as Strings