Class PwnedV2Extension

  • All Implemented Interfaces:
    com.unboundid.directory.sdk.common.internal.Configurable, com.unboundid.directory.sdk.common.internal.ExampleUsageProvider, com.unboundid.directory.sdk.common.internal.Reconfigurable<com.unboundid.directory.sdk.http.config.HTTPServletExtensionConfig>, com.unboundid.directory.sdk.common.internal.UnboundIDExtension

    public class PwnedV2Extension
    extends com.unboundid.directory.sdk.http.api.HTTPServletExtension
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.unboundid.ldap.sdk.ResultCode applyConfiguration​(com.unboundid.directory.sdk.http.config.HTTPServletExtensionConfig config, com.unboundid.util.args.ArgumentParser parser, List<String> adminActionsRequired, List<String> messages)
      Performs the necessary processing to apply or initialize configuration to the instance of the extension
      javax.servlet.http.HttpServlet createServlet​(com.unboundid.directory.sdk.http.types.HTTPServerContext httpServerContext, com.unboundid.directory.sdk.http.config.HTTPServletExtensionConfig httpServletExtensionConfig, com.unboundid.util.args.ArgumentParser argumentParser)
      Performs the necessary processing to
      void defineConfigArguments​(com.unboundid.util.args.ArgumentParser parser)
      Declare configuration arguments for the extension
      String[] getExtensionDescription()  
      String getExtensionName()  
      List<String> getServletPaths()
      Performs the necessary processing to return the paths the extension can be reached at
      • Methods inherited from class com.unboundid.directory.sdk.http.api.HTTPServletExtension

        doPostRegistrationProcessing, doPostShutdownProcessing, getExamplesArgumentSets, getServletFilters, getServletInitOrder, getServletInitParameters, isConfigurationAcceptable
    • Constructor Detail

      • PwnedV2Extension

        public PwnedV2Extension()
    • Method Detail

      • getExtensionName

        public String getExtensionName()
        Specified by:
        getExtensionName in interface com.unboundid.directory.sdk.common.internal.UnboundIDExtension
        Specified by:
        getExtensionName in class com.unboundid.directory.sdk.http.api.HTTPServletExtension
        Returns:
        the extension name for display purpose (for example in manage-extension, dsconfig)
      • getExtensionDescription

        public String[] getExtensionDescription()
        Specified by:
        getExtensionDescription in interface com.unboundid.directory.sdk.common.internal.UnboundIDExtension
        Specified by:
        getExtensionDescription in class com.unboundid.directory.sdk.http.api.HTTPServletExtension
        Returns:
        an array of strings treated as paragraphs for display purpose
      • defineConfigArguments

        public void defineConfigArguments​(com.unboundid.util.args.ArgumentParser parser)
                                   throws com.unboundid.util.args.ArgumentException
        Declare configuration arguments for the extension
        Specified by:
        defineConfigArguments in interface com.unboundid.directory.sdk.common.internal.Configurable
        Overrides:
        defineConfigArguments in class com.unboundid.directory.sdk.http.api.HTTPServletExtension
        Parameters:
        parser - the argument parser
        Throws:
        com.unboundid.util.args.ArgumentException - if any declaration encountered a problem
      • applyConfiguration

        public com.unboundid.ldap.sdk.ResultCode applyConfiguration​(com.unboundid.directory.sdk.http.config.HTTPServletExtensionConfig config,
                                                                    com.unboundid.util.args.ArgumentParser parser,
                                                                    List<String> adminActionsRequired,
                                                                    List<String> messages)
        Performs the necessary processing to apply or initialize configuration to the instance of the extension
        Specified by:
        applyConfiguration in interface com.unboundid.directory.sdk.common.internal.Reconfigurable<com.unboundid.directory.sdk.http.config.HTTPServletExtensionConfig>
        Overrides:
        applyConfiguration in class com.unboundid.directory.sdk.http.api.HTTPServletExtension
        Parameters:
        config - the configuration object for the instance of the extension
        parser - the argument parser
        adminActionsRequired - a list of message in case administrative action is required
        messages - a list of messages about applying configuration to the instance of the extension
        Returns:
        SUCCESS if configuration was applied successfully
      • createServlet

        public javax.servlet.http.HttpServlet createServlet​(com.unboundid.directory.sdk.http.types.HTTPServerContext httpServerContext,
                                                            com.unboundid.directory.sdk.http.config.HTTPServletExtensionConfig httpServletExtensionConfig,
                                                            com.unboundid.util.args.ArgumentParser argumentParser)
                                                     throws com.unboundid.ldap.sdk.LDAPException
        Performs the necessary processing to
        Specified by:
        createServlet in class com.unboundid.directory.sdk.http.api.HTTPServletExtension
        Parameters:
        httpServerContext - the server context
        httpServletExtensionConfig - the configuration object for the instance of the extension
        argumentParser - the argument parser
        Throws:
        com.unboundid.ldap.sdk.LDAPException - in case there were any issues in creating the servlet
      • getServletPaths

        public List<String> getServletPaths()
        Performs the necessary processing to return the paths the extension can be reached at
        Specified by:
        getServletPaths in class com.unboundid.directory.sdk.http.api.HTTPServletExtension
        Returns:
        a list of paths