HttpServerScopes (WildFly Elytron Parent 2.1.0.Final API)

All Known Subinterfaces:

HttpExchangeSpi, HttpScopeNotification, HttpServerRequest

All Known Implementing Classes:

BaseHttpServerRequest, HttpAuthenticator.AuthenticationExchange, HttpServerRequestWrapper, PrivilegedServerMechanism.HttpServerRequestWrapper, ProgrammaticSingleSignOnCache.SSOHttpServerRequest
```
public interface HttpServerScopes
```
Interface providing access to context specific HttpScope instances.

Author:

Darran Lofthouse

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`HttpScope`	`getScope(Scope scope)`	Get the specified `HttpScope` if available.
`HttpScope`	`getScope(Scope scope, String id)`	Get the specified `HttpScope` with the specified ID.
`Collection<String>`	`getScopeIds(Scope scope)`	Get the IDs available for the scope specified.

- Method Detail
  - getScope
```
HttpScope getScope(Scope scope)
```
    Get the specified HttpScope if available.
    
    Parameters:
    
    scope - the type of the scope required.
    
    Returns:
    
    the scope specified or null if not supported.
  - getScopeIds
```
Collection<String> getScopeIds(Scope scope)
```
    Get the IDs available for the scope specified.
    
    Parameters:
    
    scope - the scope the IDs are required for.
    
    Returns:
    
    The IDs available for the scope specified or null if the scope specified does not support obtaining scopes by ID.
  - getScope
```
HttpScope getScope(Scope scope,
                   String id)
```
    Get the specified HttpScope with the specified ID.
    
    Parameters:
    
    scope - the type of the scope required.
    
    id - the id of the scope instance required.
    
    Returns:
    
    the scope specified or null if not supported or if the scope with that ID does not exist.