Package net.shibboleth.idp.installer.plugin.impl

Class PluginState

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
net.shibboleth.idp.installer.plugin.impl.PluginState
All Implemented Interfaces:
Component, DestructableComponent, InitializableComponent
public class PluginState extends AbstractInitializableComponent
A class which will answer questions about a plugin state as of now (by querying the information Resources for the current published state).

  • Field Details

    • plugin

      @Nonnull private final IdPPlugin plugin
      The plug in in question.

    • myPluginInfo

      @NonnullAfterInit private InstallableComponentInfo myPluginInfo
      My Plugin Info.

    • myPluginVersion

      @Nonnull private final InstallableComponentVersion myPluginVersion
      The version of this plugin.

    • log

      @Nonnull private final org.slf4j.Logger log
      Class logger.

    • httpClient

      @NonnullAfterInit private org.apache.hc.client5.http.classic.HttpClient httpClient
      The HttpClient to use.

    • httpClientSecurityParameters

      @Nullable private HttpClientSecurityParameters httpClientSecurityParameters
      The Injected security parameters.

    • updateOverrideURLs

      @Nonnull private final List<URL> updateOverrideURLs
      If overridden these are the urls to us for update (rather than what the plguin asks for.

  • Constructor Details

    • PluginState

      public PluginState(@Nonnull IdPPlugin description, List<URL> updateOverrides)
      Constructor.
      Parameters:
      description - what we are talking about.
      updateOverrides - override for update locations. An empty list signifies no overrride.

  • Method Details

    • getPluginInfo

      @Nonnull public InstallableComponentInfo getPluginInfo()
      get our PluginInfo.
      Returns:
      our PluginInfo.

    • populate

      private boolean populate(@Nonnull Resource propertyResource)
      (try to) populate the information about this plugin.
      Parameters:
      propertyResource - where to start looking
      Returns:
      whether it worked

    • setHttpClient

      public void setHttpClient(@Nonnull org.apache.hc.client5.http.classic.HttpClient what)
      Set the client.
      Parameters:
      what - what to set.

    • getHttpClientSecurityParameters

      @Nullable public HttpClientSecurityParameters getHttpClientSecurityParameters()
      Gets HttpClient security parameters, if any.
      Returns:
      HTTP client security parameters to use

    • setHttpClientSecurityParameters

      public void setHttpClientSecurityParameters(@Nullable HttpClientSecurityParameters params)
      Sets HttpClient security parameters to use.
      Parameters:
      params - security parameters

    • doInitialize

      protected void doInitialize() throws ComponentInitializationException
      /**
      Overrides:
      doInitialize in class AbstractInitializableComponent
      Throws:
      ComponentInitializationException