Class CredentialsFactory


  • public final class CredentialsFactory
    extends Object
    This factory can be used by login modules to create Equinox public and private credentials. It is expected that as a result of successful login credentials are added to the Subject.

    This class is not intended to be instantiated or extended by clients.

    Restriction:
    This class is not intended to be instantiated by clients.
    • Constructor Detail

      • CredentialsFactory

        public CredentialsFactory()
    • Method Detail

      • publicCredential

        public static IPublicCredential publicCredential​(String name,
                                                         Principal primaryRole,
                                                         String providerID)
        Login modules can use this method to create new public credentials as a result of the login process.
        Parameters:
        name - user's name
        primaryRole - user's primary role, null if not available
        providerID - the ID of the creator of this public credential; if provider was described as an extension, use the extension ID
        Returns:
        new public credential
        See Also:
        Subject.getPublicCredentials()
      • publicCredential

        public static IPublicCredential publicCredential​(String name,
                                                         Principal[] roles,
                                                         String providerID)
        Login modules can use this method to create new public credentials as a result of the login process.
        Parameters:
        name - user's name
        roles - user's roles, null if not available
        providerID - the ID of the creator of this public credential; if provider was described as an extension, use the extension ID
        Returns:
        new public credential
        See Also:
        Subject.getPublicCredentials()
      • privateCredential

        public static IPrivateCredential privateCredential​(PBEKeySpec privateKey,
                                                           String providerID)
        Login modules can use this method to create new private credentials.
        Parameters:
        privateKey - the private key to be stored in this credential
        providerID - the ID of the creator of this private credential; if provider was described as an extension, use the extension ID
        Returns:
        new private credential
        See Also:
        Subject.getPrivateCredentials()