AuthorizationRequest (OAuth for Spring Security 2.4.0.BUILD-SNAPSHOT API)

java.lang.ObjectSE
- org.springframework.security.oauth2.provider.AuthorizationRequest

実装済みのインターフェース一覧:
SerializableSE
```
public class AuthorizationRequest
extends ObjectSE
implements SerializableSE
```
OAuth 2 クライアントによる認可リクエスト。通常は AuthorizationEndpoint によって受信および処理されます。このクラスは認可プロセス全体にわたって操作されることを意図しているため、一時的なものとして扱われ、長期間保存されません。長期間保存する場合は、読み取り専用の OAuth2Request クラスを使用します。HTTP リクエストパラメーターはパラメーターマップに保存され、リクエストのライフサイクル全体にわたってサーバーが行う処理は個々のプロパティに保存されます。元のリクエストパラメーターは、パラメーターマップを通じて引き続き使用できます。便宜上、元の値を取得するための定数が定義されています。ただし、パラメーターマップは変更できないため、処理によって元の値が削除されることはありません。このクラスは、エンドユーザーが認可プロセス (複数のページリクエストにまたがる場合があります) を実行する間、認可リクエストを SessionAttributes メンバーとして保存できるようにするために SerializableSE になっています。
作成者:
Ryan Heaton, Dave Syer, Amanda Anganes
関連事項:
連載形式

コンストラクター概要

コンストラクター
コンストラクターと説明
`AuthorizationRequest()` デフォルトコンストラクター。
`AuthorizationRequest(MapSE<StringSE, StringSE> authorizationParameters, MapSE<StringSE, StringSE> approvalParameters, StringSE clientId, SetSE<StringSE> scope, SetSE<StringSE> resourceIds, CollectionSE<? extends org.springframework.security.core.GrantedAuthority> authorities, boolean approved, StringSE state, StringSE redirectUri, SetSE<StringSE> responseTypes)` 完全なコンストラクター。
`AuthorizationRequest(StringSE clientId, CollectionSE<StringSE> scopes)` 単体テスト用の便利なコンストラクターです。多くの場合、クライアント ID とスコープのみが必要なフィールドです。

方法の概要

メソッド
修飾子と型	メソッドと説明
`OAuth2Request`	`createOAuth2Request()`
`boolean`	`equals(ObjectSE obj)`
`MapSE<StringSE, StringSE>`	`getApprovalParameters()`
`CollectionSE<? extends org.springframework.security.core.GrantedAuthority>`	`getAuthorities()`
`StringSE`	`getClientId()`
`MapSE<StringSE, SerializableSE>`	`getExtensions()`
`StringSE`	`getRedirectUri()`
`MapSE<StringSE, StringSE>`	`getRequestParameters()` 警告: ほとんどのクライアントは、このマップから値を取得するのではなく、このクラスの個々のプロパティ ({ `getScope()` や { `getClientId()` など) を使用する必要があります。
`SetSE<StringSE>`	`getResourceIds()`
`SetSE<StringSE>`	`getResponseTypes()`
`SetSE<StringSE>`	`getScope()`
`StringSE`	`getState()`
`int`	`hashCode()`
`boolean`	`isApproved()`
`void`	`setApprovalParameters(MapSE<StringSE, StringSE> approvalParameters)`
`void`	`setApproved(boolean approved)`
`void`	`setAuthorities(CollectionSE<? extends org.springframework.security.core.GrantedAuthority> authorities)`
`void`	`setClientId(StringSE clientId)`
`void`	`setExtensions(MapSE<StringSE, SerializableSE> extensions)`
`void`	`setRedirectUri(StringSE redirectUri)`
`void`	`setRequestParameters(MapSE<StringSE, StringSE> requestParameters)` この認可リクエストにリクエストパラメーターを設定します。これは元のリクエストパラメーターを表し、処理中に変更してはなりません。
`void`	`setResourceIds(SetSE<StringSE> resourceIds)`
`void`	`setResourceIdsAndAuthoritiesFromClientDetails(ClientDetails clientDetails)` ClientDetails オブジェクトから継承して、このリクエストに対する resourceIds と権限を設定する便利なメソッド。
`void`	`setResponseTypes(SetSE<StringSE> responseTypes)`
`void`	`setScope(CollectionSE<StringSE> scope)` スコープ値を設定します。
`void`	`setState(StringSE state)`

クラス java.lang.ObjectSE から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, toString, wait, waitSE, waitSE

コンストラクターの詳細

AuthorizationRequest
```
public AuthorizationRequest()
```
デフォルトコンストラクター。

AuthorizationRequest

public AuthorizationRequest(MapSE<StringSE,StringSE> authorizationParameters,
                    MapSE<StringSE,StringSE> approvalParameters,
                    StringSE clientId,
                    SetSE<StringSE> scope,
                    SetSE<StringSE> resourceIds,
                    CollectionSE<? extends org.springframework.security.core.GrantedAuthority> authorities,
                    boolean approved,
                    StringSE state,
                    StringSE redirectUri,
                    SetSE<StringSE> responseTypes)

完全なコンストラクター。

AuthorizationRequest
```
public AuthorizationRequest(StringSE clientId,
                    CollectionSE<StringSE> scopes)
```
単体テスト用の便利なコンストラクターです。多くの場合、クライアント ID とスコープのみが必要なフィールドです。
パラメーター:
clientId -
scopes -

メソッドの詳細
- createOAuth2Request
```
public OAuth2Request createOAuth2Request()
```
- setResourceIdsAndAuthoritiesFromClientDetails
```
public void setResourceIdsAndAuthoritiesFromClientDetails(ClientDetails clientDetails)
```
  ClientDetails オブジェクトから継承して、このリクエストに対する resourceIds と権限を設定する便利なメソッド。
  パラメーター:
  clientDetails -
- getApprovalParameters
```
public MapSE<StringSE,StringSE> getApprovalParameters()
```
- setApprovalParameters
```
public void setApprovalParameters(MapSE<StringSE,StringSE> approvalParameters)
```
- getState
```
public StringSE getState()
```
- setState
```
public void setState(StringSE state)
```
- getResponseTypes
```
public SetSE<StringSE> getResponseTypes()
```
- setResponseTypes
```
public void setResponseTypes(SetSE<StringSE> responseTypes)
```
- setRedirectUri
```
public void setRedirectUri(StringSE redirectUri)
```
- setApproved
```
public void setApproved(boolean approved)
```
- setAuthorities
```
public void setAuthorities(CollectionSE<? extends org.springframework.security.core.GrantedAuthority> authorities)
```
- getExtensions
```
public MapSE<StringSE,SerializableSE> getExtensions()
```
  戻り値:
  拡張機能
- setExtensions
```
public void setExtensions(MapSE<StringSE,SerializableSE> extensions)
```
- setResourceIds
```
public void setResourceIds(SetSE<StringSE> resourceIds)
```
- setClientId
```
public void setClientId(StringSE clientId)
```
- setScope
```
public void setScope(CollectionSE<StringSE> scope)
```
  スコープ値を設定します。コレクションにスコープ値が 1 つだけ含まれている場合、このメソッドは OAuth2Utils.parseParameterList(java.lang.String) を使用してその値をコレクションに解析します。
  パラメーター:
  scope -
  関連事項:
  TokenRequest.setScope(java.util.Collection<java.lang.String>)
- setRequestParameters
```
public void setRequestParameters(MapSE<StringSE,StringSE> requestParameters)
```
  この認可リクエストにリクエストパラメーターを設定します。これは元のリクエストパラメーターを表し、処理中に変更されることはありません。渡されたマップは、変更不可能なマップインスタンスにラップされます。
  パラメーター:
  requestParameters -
  関連事項:
  TokenRequest.setRequestParameters(java.util.Map<java.lang.String, java.lang.String>)
- getResourceIds
```
public SetSE<StringSE> getResourceIds()
```
  戻り値:
  resourceIds
- getAuthorities
```
public CollectionSE<? extends org.springframework.security.core.GrantedAuthority> getAuthorities()
```
  戻り値:
  権限
- isApproved
```
public boolean isApproved()
```
  戻り値:
  承認された
- getRedirectUri
```
public StringSE getRedirectUri()
```
  戻り値:
  redirectUri
- hashCode
```
public int hashCode()
```
- equals
```
public boolean equals(ObjectSE obj)
```
- getClientId
```
public StringSE getClientId()
```
- getScope
```
public SetSE<StringSE> getScope()
```
- getRequestParameters
```
public MapSE<StringSE,StringSE> getRequestParameters()
```
  警告: ほとんどのクライアントは、このマップから値を取得するのではなく、このクラスの個々のプロパティ ({ getScope() や { getClientId() など) を使用する必要があります。
  戻り値:
  元の変更されていないリクエストパラメーターのセット

クラス AuthorizationRequest

コンストラクター概要

方法の概要

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

AuthorizationRequest

AuthorizationRequest

AuthorizationRequest

メソッドの詳細

createOAuth2Request

setResourceIdsAndAuthoritiesFromClientDetails

getApprovalParameters

setApprovalParameters

getState

setState

getResponseTypes

setResponseTypes

setRedirectUri

setApproved

setAuthorities

getExtensions

setExtensions

setResourceIds

setClientId

setScope

setRequestParameters

getResourceIds

getAuthorities

isApproved

getRedirectUri

hashCode

equals

getClientId

getScope

getRequestParameters