Specs

query(idp :: Shin.IdP.t(), service :: binary() | atom(), options :: keyword()) ::
  {:ok, map()} | {:error, binary()}

Looks up information about the specified Shibboleth IdP sub-service, returning it in a results tuple.

At the moment the only useful information concerns when the service restarted (or failed to restart)

The service can be specified using the full Shibboleth service ID or a Shin service alias. These are listed in your IdP struct.

Examples

  {:ok, info} = Shin.Service.query(idp, "shibboleth.AttributeRegistryService")

Specs

query!(idp :: Shin.IdP.t(), service :: binary() | atom(), options :: keyword()) ::
  map()

Looks up information about the specified Shibboleth IdP sub-service.

At the moment the only useful information concerns when the service restarted (or failed to restart)

The service can be specified using the full Shibboleth service ID or a Shin service alias. These are listed in your IdP struct.

Examples

  info = Shin.Service.query!(idp, "shibboleth.AttributeRegistryService")

Specs

reload(idp :: Shin.IdP.t(), service :: atom() | binary(), options :: keyword()) ::
  {:ok, binary()} | {:error, binary()}

Sends a reload request for the specified service to the IdP. This should cause the IdP to reload the configuration for that service.

Pass an IdP as the first parameter. The second parameter is either a full service ID or an alias provided by Shin.

Examples

  {:ok, message} = Shin.Service.reload(idp, "shibboleth.MetadataResolverService")
  {:ok, message} = Shin.Service.reload(idp, :metadata_resolver)

Specs

reload!(idp :: Shin.IdP.t(), service :: atom() | binary(), options :: keyword()) ::
  binary()

Sends a reload request for the specified service to the IdP. This should cause the IdP to reload the configuration for that service.

Pass an IdP as the first parameter. The second parameter is either a full service ID or an alias provided by Shin.

Examples

  message = Shin.Service.reload!(idp, "shibboleth.MetadataResolverService")
  message = Shin.Service.reload!(idp, :metadata_resolver)