Trait oxide_auth::endpoint::Endpoint
source · pub trait Endpoint<Request: WebRequest> {
type Error;
// Required methods
fn registrar(&self) -> Option<&dyn Registrar>;
fn authorizer_mut(&mut self) -> Option<&mut dyn Authorizer>;
fn issuer_mut(&mut self) -> Option<&mut dyn Issuer>;
fn owner_solicitor(&mut self) -> Option<&mut dyn OwnerSolicitor<Request>>;
fn scopes(&mut self) -> Option<&mut dyn Scopes<Request>>;
fn response(
&mut self,
request: &mut Request,
kind: Template<'_>
) -> Result<Request::Response, Self::Error>;
fn error(&mut self, err: OAuthError) -> Self::Error;
fn web_error(&mut self, err: Request::Error) -> Self::Error;
// Provided method
fn extension(&mut self) -> Option<&mut dyn Extension> { ... }
}Expand description
Fuses requests and primitives into a coherent system to give a response.
There are multiple different valid ways to produce responses and react to internal errors for a single request type. This trait should provide those mechanisms, including trying to recover from primitive errors where appropriate.
To reduce the number of necessary impls and provide a single interface to a single trait, this
trait defines accessor methods for all possibly needed primitives. Note that not all flows
actually access all primitives. Thus, an implementation does not necessarily have to return
something in registrar, authorizer, issuer_mut but failing to do so will also fail flows
that try to use them.
Panics
It is expected that the endpoint primitive functions are consistent, i.e. they don’t begin
returning None after having returned Some(registrar) previously for example. This ensures
that the checks executed by the flow preparation methods catch missing primitives. When this
contract is violated, the execution of a flow may lead to a panic.
Required Associated Types§
Required Methods§
sourcefn registrar(&self) -> Option<&dyn Registrar>
fn registrar(&self) -> Option<&dyn Registrar>
A registrar if this endpoint can access one.
Returning None will implicate failing any flow that requires a registrar but does not
have any effect on flows that do not require one.
An authorizer if this endpoint can access one.
Returning None will implicate failing any flow that requires an authorizer but does not
have any effect on flows that do not require one.
sourcefn issuer_mut(&mut self) -> Option<&mut dyn Issuer>
fn issuer_mut(&mut self) -> Option<&mut dyn Issuer>
An issuer if this endpoint can access one.
Returning None will implicate failing any flow that requires an issuer but does not have
any effect on flows that do not require one.
sourcefn owner_solicitor(&mut self) -> Option<&mut dyn OwnerSolicitor<Request>>
fn owner_solicitor(&mut self) -> Option<&mut dyn OwnerSolicitor<Request>>
Return the system that checks owner consent.
Returning None will implicated failing the authorization code flow but does have any
effect on other flows.
sourcefn scopes(&mut self) -> Option<&mut dyn Scopes<Request>>
fn scopes(&mut self) -> Option<&mut dyn Scopes<Request>>
Determine the required scopes for a request.
The client must fulfill any one scope, so returning an empty slice will always deny the request.
sourcefn response(
&mut self,
request: &mut Request,
kind: Template<'_>
) -> Result<Request::Response, Self::Error>
fn response( &mut self, request: &mut Request, kind: Template<'_> ) -> Result<Request::Response, Self::Error>
Generate a prototype response.
The endpoint can rely on this being called at most once for each flow, if it wants to preallocate the response or return a handle on an existing prototype.
sourcefn error(&mut self, err: OAuthError) -> Self::Error
fn error(&mut self, err: OAuthError) -> Self::Error
Wrap an error.