com.ibm.mfp.server.registration.external.model

Class ClientData

  • java.lang.Object
    • com.ibm.mfp.server.registration.external.model.ClientData

  • public class ClientData
extends java.lang.Object
    Data of a registered client.
    The class constructors are reserved for internal use only. Adapters can use the methods getClientRegistrationData or findClientRegistrationData in AdapterSecurityContext to get instances of this class. Adapters can change the registration data stored in this class (for examplem add public or protected attributes). After making changes, adapters must call AdapterSecurityContext.storeClientRegistrationData() to store the changes.

    • Constructor Summary

      Constructors 
      Constructor and Description
      ClientData()
      Reserved for internal use only.
      ClientData(java.lang.String clientId, RegistrationData registration, boolean enabled, boolean registrationComplete, long lastActivityTime, java.lang.String signatureAlgorithm, java.util.Map webKey, java.util.Map users, PersistentAttributes publicAttributes, PersistentAttributes protectedAttributes, java.security.interfaces.RSAPublicKey publicKey)
      Reserved for internal use only.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getClientId()
      Gets the unique ID of the application instance.
      long getLastActivityTime()
      Gets the timestamp of the last registered client activity, precise up to an hour.
      PersistentAttributes getProtectedAttributes()
      Gets the custom protected attributes.
      PersistentAttributes getPublicAttributes()
      Gets the custom public attributes.
      java.security.interfaces.RSAPublicKey getPublicKey()
      Gets the public key used by the application instance.
      RegistrationData getRegistration()
      Gets the data reported by the mobile client during the registration, including the application and the device it is installed on.
      boolean getRegistrationComplete()
      Returns true if the registration is complete, false if the registration is in progress
      java.lang.String getSignatureAlgorithm()
      Gets the name of the signature algorithm used by the application instance.
      java.util.Map getUsers()
      Gets the users associated with the application instance.
      java.util.Map getWebKey()
      Returns a JSON representation of the public key used by the application instance.
      boolean isEnabled()
      Returns true if the application instance is enabled, false otherwise.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ClientData

        public ClientData()
        Reserved for internal use only.

      • ClientData

        public ClientData(java.lang.String clientId,
          RegistrationData registration,
          boolean enabled,
          boolean registrationComplete,
          long lastActivityTime,
          java.lang.String signatureAlgorithm,
          java.util.Map webKey,
          java.util.Map users,
          PersistentAttributes publicAttributes,
          PersistentAttributes protectedAttributes,
          java.security.interfaces.RSAPublicKey publicKey)
        Reserved for internal use only.

    • Method Detail

      • getClientId

        public java.lang.String getClientId()
        Gets the unique ID of the application instance.
        Returns:
        client ID

      • getRegistration

        public RegistrationData getRegistration()
        Gets the data reported by the mobile client during the registration, including the application and the device it is installed on.
        Returns:
        mobile client registration data

      • isEnabled

        public boolean isEnabled()
        Returns true if the application instance is enabled, false otherwise.
        Returns:
        true if the application instance is enabled, false otherwise

      • getSignatureAlgorithm

        public java.lang.String getSignatureAlgorithm()
        Gets the name of the signature algorithm used by the application instance.
        Returns:
        algorithm name

      • getWebKey

        public java.util.Map getWebKey()
        Returns a JSON representation of the public key used by the application instance. Returns null if the client has no public key
        Returns:
        JSON representation of the public key; null if the client has no public key
        See Also:
        ClientData.getPublicKey()

      • getPublicKey

        public java.security.interfaces.RSAPublicKey getPublicKey()
        Gets the public key used by the application instance. Null if the client has no public key.
        Returns:
        the public key, may be null
        See Also:
        ClientData.getWebKey()

      • getRegistrationComplete

        public boolean getRegistrationComplete()
        Returns true if the registration is complete, false if the registration is in progress
        Returns:
        true if the registration is complete, false if the registration is in progress

      • getLastActivityTime

        public long getLastActivityTime()
        Gets the timestamp of the last registered client activity, precise up to an hour. The timestamp is provided as Unix time, that is, milliseconds since Unix Epoch.
        Returns:
        time of last recorded client activity (in milliseconds)

      • getUsers

        public java.util.Map getUsers()
        Gets the users associated with the application instance.
        Returns:
        map with the security check name as a key, and authenticated user as value

      • getPublicAttributes

        public PersistentAttributes getPublicAttributes()
        Gets the custom public attributes.
        Returns:
        modifyable the public attributes

      • getProtectedAttributes

        public PersistentAttributes getProtectedAttributes()
        Gets the custom protected attributes.
        Returns:
        modifyable the protected attributes


© Copyright IBM Corp. 2006, 2015. All Rights Reserved.