com.pingidentity.pa.sdk.accessor.tps

Annotation Type OAuthAuthorizationServer

@Documented
 @Qualifier
 @Target(value={FIELD,METHOD})
 @Retention(value=RUNTIME)
public @interface OAuthAuthorizationServer

This annotation is used to obtain a reference to the ThirdPartyServiceModel that corresponds to the OAuth authorization server configured in PingAccess, without requiring the administrator to configure a plugin to use the authorization server. This facilitates tighter integration between a custom plugin and the authorization server.

This annotation should be associated with a field or setter method in a PluginConfiguration class to instruct PingAccess to inject the appropriate ThirdPartyServiceModel instance. Additionally, the field or setter method should also be annotated with the Inject annotation. For example:

 public class ExampleConfiguration extends SimplePluginConfiguration
 {
     private ThirdPartyServiceModel oAuthAuthorizationServer;

     @Inject
     @OAuthAuthorizationServer
     public void setOAuthAuthorizationServer(ThirdPartyServiceModel oAuthAuthorizationServer)
     {
          this.oAuthAuthorizationServer = oAuthAuthorizationServer;
     }
 }
 

If the OAuth authorization server is not configured, the save operation for any plugin configuration that uses this annotation will fail. This validation is enforced by PingAccess before invoking the ConfigurablePlugin.configure(PluginConfiguration).