diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ca61aa2..62233aa1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,20 @@ +# Version 1.7.10 + +### Bug fixes +None. + +See list of bug fixes for native platforms: + +* iOS Mobile SDK for CA Mobile API Gateway [Change Log](https://github.com/CAAPIM/iOS-MAS-Foundation/blob/Stable/CHANGELOG.md#version-1710) +* Android™ Mobile SDK for CA Mobile API Gateway [Change Log](https://github.com/CAAPIM/Android-MAS-SDK/blob/Stable/ChangeLog.md#version-1710) + +### Enhancement +* MASFoundation.iOS updated with latest iOS 1.7.10 version +* MASFoundation.Android updated with latest Android 1.7.10 version + +### Deprecated methods +None. + # Version 1.7.00 ### Bug fixes diff --git a/sample/iOS/BasicAuthSample/BasicAuthSample.csproj b/sample/iOS/BasicAuthSample/BasicAuthSample.csproj index e73635f1..0235be4a 100644 --- a/sample/iOS/BasicAuthSample/BasicAuthSample.csproj +++ b/sample/iOS/BasicAuthSample/BasicAuthSample.csproj @@ -89,10 +89,7 @@ - packages\MASFoundation.Xamarin.1.7.0-RC54\lib\xamarin.ios\MASFoundation.iOS.dll - - - packages\MASFoundation.Xamarin.1.7.0-RC54\lib\xamarin.ios\MASFoundation.iOS.dll + packages\MASFoundation.Xamarin.1.7.0\lib\xamarin.ios\MASFoundation.iOS.dll diff --git a/sample/iOS/BasicAuthSample/packages.config b/sample/iOS/BasicAuthSample/packages.config index 7209f51d..686bda63 100644 --- a/sample/iOS/BasicAuthSample/packages.config +++ b/sample/iOS/BasicAuthSample/packages.config @@ -1,5 +1,5 @@  - + \ No newline at end of file diff --git a/source/MASFoundation.Android/Jars/mas-foundation-debug.aar b/source/MASFoundation.Android/Jars/mas-foundation-debug.aar deleted file mode 100644 index 07d5d6e5..00000000 Binary files a/source/MASFoundation.Android/Jars/mas-foundation-debug.aar and /dev/null differ diff --git a/source/MASFoundation.Android/Jars/mas-foundation-release.aar b/source/MASFoundation.Android/Jars/mas-foundation-release.aar index 4c1a42c3..b6337bdd 100644 Binary files a/source/MASFoundation.Android/Jars/mas-foundation-release.aar and b/source/MASFoundation.Android/Jars/mas-foundation-release.aar differ diff --git a/source/MASFoundation.Android/JavaDocs/allclasses-frame.html b/source/MASFoundation.Android/JavaDocs/allclasses-frame.html index 9867ca9e..db79b433 100644 --- a/source/MASFoundation.Android/JavaDocs/allclasses-frame.html +++ b/source/MASFoundation.Android/JavaDocs/allclasses-frame.html @@ -2,9 +2,9 @@ - -All Classes (mas-foundation API) - + +All Classes + @@ -12,11 +12,220 @@

All Classes

diff --git a/source/MASFoundation.Android/JavaDocs/allclasses-noframe.html b/source/MASFoundation.Android/JavaDocs/allclasses-noframe.html index 1dba3ebc..4f6dc5bf 100644 --- a/source/MASFoundation.Android/JavaDocs/allclasses-noframe.html +++ b/source/MASFoundation.Android/JavaDocs/allclasses-noframe.html @@ -2,9 +2,9 @@ - -All Classes (mas-foundation API) - + +All Classes + @@ -12,11 +12,220 @@

All Classes

diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/EventDispatcher.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/EventDispatcher.html new file mode 100644 index 00000000..275b2679 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/EventDispatcher.html @@ -0,0 +1,413 @@ + + + + + +EventDispatcher + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core
+

Class EventDispatcher

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.util.Observable
      • +
    • +
        +
      • com.ca.mas.core.EventDispatcher
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class EventDispatcher
+extends java.util.Observable
    +
    Dispatch an event to an Observer which listens for the event.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EventDispatcher

        +
        public EventDispatcher()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasChanged

        +
        public boolean hasChanged()
        +
        +
        Overrides:
        +
        hasChanged in class java.util.Observable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MAGResultReceiver.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MAGResultReceiver.html new file mode 100644 index 00000000..40fa8d3d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MAGResultReceiver.html @@ -0,0 +1,408 @@ + + + + + +MAGResultReceiver + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core
+

Class MAGResultReceiver<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • android.os.ResultReceiver
      • +
    • +
        +
      • com.ca.mas.core.MAGResultReceiver<T>
        • +
      +
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface android.os.Parcelable

        +android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class android.os.ResultReceiver

        +CREATOR
        • +
      +
        +
      • + + +

        Fields inherited from interface android.os.Parcelable

        +CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      abstract voidonError(MAGError error) +
      Callback when failed to invoke the MAG API and Target API.
      +
      protected voidonReceiveResult(int resultCode, + android.os.Bundle resultData) 
      voidonRequestCancelled(android.os.Bundle data) +
      Callback when the request is cancelled.
      +
      abstract voidonSuccess(MASResponse<T> response) +
      Callback when successfully invoked the target API and the target API return http status code + within the range 200 - 299.
      +
      +
        +
      • + + +

        Methods inherited from class android.os.ResultReceiver

        +describeContents, send, writeToParcel
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MAGResultReceiver

        +
        public MAGResultReceiver(android.os.Handler handler)
        +
        • +
      + + + +
        +
      • +

        MAGResultReceiver

        +
        public MAGResultReceiver()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onReceiveResult

        +
        protected void onReceiveResult(int resultCode,
+                               android.os.Bundle resultData)
        +
        +
        Overrides:
        +
        onReceiveResult in class android.os.ResultReceiver
        +
        +
        • +
      + + + +
        +
      • +

        onSuccess

        +
        public abstract void onSuccess(MASResponse<T> response)
        +
        Callback when successfully invoked the target API and the target API return http status code + within the range 200 - 299.
        +
        +
        Parameters:
        +
        response - The HttpResponse of the endpoint.
        +
        +
        • +
      + + + +
        +
      • +

        onError

        +
        public abstract void onError(MAGError error)
        +
        Callback when failed to invoke the MAG API and Target API.
        +
        • +
      + + + +
        +
      • +

        onRequestCancelled

        +
        public void onRequestCancelled(android.os.Bundle data)
        +
        Callback when the request is cancelled.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSso.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSso.html new file mode 100644 index 00000000..06cc1ec1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSso.html @@ -0,0 +1,516 @@ + + + + + +MobileSso + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core
+

Interface MobileSso

+
+
+
+
    +
  • +
    +
    +
    public interface MobileSso
    +

    Top-level interface for the Mobile SSO SDK.

    + Use MobileSsoFactory to obtain an implementation of this.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidauthenticate(MASAuthCredentials credentials, + MAGResultReceiver<org.json.JSONObject> resultReceiver) +
      Authenticates a user with a MASAuthCredentials object.
      +
      voidauthorize(java.lang.String url, + android.os.ResultReceiver resultReceiver) +
      Performs a remote authorization with the provider URL.
      +
      voidcancelAllRequests(android.os.Bundle data) +
      Cancels all requests.
      +
      voidcancelRequest(long requestId, + android.os.Bundle data) +
      Cancels the specified request ID.
      +
      voiddestroyAllPersistentTokens() +
      Clear all tokens in the shared token store.
      +
      AuthenticationProvidergetAuthenticationProvider() +
      Retrieves the Authentication Providers from the server.
      +
      booleanisDeviceRegistered() +
      Checks if the device has already been registered.
      +
      booleanisLogin() +
      Check if the user has already been logged in.
      +
      voidlogout(boolean contactServer) +
      Log out the current user and all SSO apps on this device, leaving the device registered, and + optionally informing the token server of the logout.
      +
      voidprocessPendingRequests() +
      Requests that any pending queued requests be processed.
      +
      longprocessRequest(MASRequest request, + android.os.ResultReceiver resultReceiver) +
      Submit a API request to be processed asynchronously.
      +
      voidremoveDeviceRegistration() +
      Remove this device registration from the server.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        processRequest

        +
        long processRequest(MASRequest request,
+                    android.os.ResultReceiver resultReceiver)
        +
        Submit a API request to be processed asynchronously. + +
          +
        • The response to the request will eventually be delivered to the specified result receiver.
          • +
        • This method returns immediately to the calling thread.
          • +
        • An activity may be started if a device lock code needs to be configured or if the user must be prompted for a username and password.
          • +
        +
        +
        Parameters:
        +
        request - the request to send. Required.
        +
        resultReceiver - the resultReceiver to notify when a response is available, or if there is an error. Required. + The result code is defined under MssoIntents RESULT_CODE_*, + To retrieve the error message from the returned Bundle with key + MssoIntents.RESULT_ERROR_MESSAGE. +

        + A helper class MAGResultReceiver defined a standard interface to capture the result + of the API request. +

        +
        Returns:
        +
        the request ID, which can be used to cancel the request, to cancel the request please refer to + cancelRequest(long, Bundle)}
        +
        +
        • +
      + + + +
        +
      • +

        authenticate

        +
        void authenticate(MASAuthCredentials credentials,
+                  MAGResultReceiver<org.json.JSONObject> resultReceiver)
        +

        Authenticates a user with a MASAuthCredentials object.

        + +

        The response to the request will eventually be delivered to the specified result receiver.

        +

        This method returns immediately to the calling thread

        +
        +
        Parameters:
        +
        credentials - the credentials to authenticate with
        +
        resultReceiver - the resultReceiver to notify when a response is available, or if there is an error. Required.
        +
        +
        • +
      + + + +
        +
      • +

        processPendingRequests

        +
        void processPendingRequests()
        +

        Requests that any pending queued requests be processed.

        +

        This can be called from an activity's onResume() method to ensure that + any pending requests waiting for an initial unlock code on the device get a chance to continue.

        +

        This method returns immediately to the calling thread.

        +

        An activity may be started if a device lock code (still) needs to be configured + or if the user must be prompted for a username and password.

        +
        • +
      + + + +
        +
      • +

        cancelRequest

        +
        void cancelRequest(long requestId,
+                   android.os.Bundle data)
        +
        Cancels the specified request ID. If the response notification has not already been delivered + by the time this method executes, a response notification will never occur for the specified request ID.
        +
        +
        Parameters:
        +
        requestId - the request ID to cancel.
        +
        data - the data to the cancelled request MAGResultReceiver.onRequestCancelled(Bundle)
        +
        +
        • +
      + + + +
        +
      • +

        cancelAllRequests

        +
        void cancelAllRequests(android.os.Bundle data)
        +
        Cancels all requests. If the response notification has not already been delivered + by the time this method executes, response notification will never occur.
        +
        +
        Parameters:
        +
        data - the data to the all the cancelled request MAGResultReceiver.onRequestCancelled(Bundle)
        +
        +
        • +
      + + + +
        +
      • +

        logout

        +
        void logout(boolean contactServer)
        +

        Log out the current user and all SSO apps on this device, leaving the device registered, and + optionally informing the token server of the logout.

        +

        This method takes no action if the use is already logged out.

        +

        This method destroys the access token and cached password (if any). If SSO is enabled, this method also + removes the ID token from the shared token store.

        +

        If contactServer is true, this method additionally makes a best-effort attempt to notify the server that the + access token (and possibly ID token) should be invalidated.

        +

        If the server needs to be contact, this will be done on the current thread. As this may take some time, + callers running on the UI thread and passing true for contactServer should consider running this method + within an AsyncTask.

        + NOTE: It is extremely important to make at least one attempt to inform the server + of the logout before destroying the tokens client side to try and prevent the server + from getting out of sync with the client. Pass contactServer=false only if + absolutely necessary (such as to avoid blocking the GUI if you have already made + at least one attempt to contact the server).
        +
        +
        Parameters:
        +
        contactServer - true to make a single best-effort attempt to notify the server of the logout so that + it can revoke the tokens. This may fail if we lack network connectivity. +
        + false to destroy the tokens client side but make no effort to inform the server that + it needs to revoke them. +
        + This option does nothing if there is no ID token (whether or not SSO is enabled).
        +
        Throws:
        +
        MssoException - if contactServer is true, and SSO is enabled, and there is an error while attempting + to notify the server of the logout.
        +
        +
        • +
      + + + +
        +
      • +

        destroyAllPersistentTokens

        +
        void destroyAllPersistentTokens()
        +

        Clear all tokens in the shared token store.

        + NOTE: You should not normally use this method. + This method destroys the client private key, effectively un-registering the device, and should only be used + for testing or recovery purposes. +

        If you just wish to log out the current SSO user see the logout(boolean) method instead.

        +
        • +
      + + + +
        +
      • +

        removeDeviceRegistration

        +
        void removeDeviceRegistration()
        +

        Remove this device registration from the server. The token server will identify the device making the request + by its TLS client certificate.

        +

        This does not affect the local cached access token, + cached username and password, or the shared token storage in any way. The client will continue to attempt + to present its TLS client certificate on future calls to the token server or a web API endpoint.

        + To destroy the client-side record of the device registration, call destroyAllPersistentTokens(). +

        The communication with the token server will occur on the current thread. As this may take some time, + callers running on the UI thread should consider running this method within an AsyncTask.

        +
        +
        Throws:
        +
        MssoException - if there is an error while attempting to tell the token server to unregister this device.
        +
        +
        • +
      + + + +
        +
      • +

        isLogin

        +
        boolean isLogin()
        +
        Check if the user has already been logged in.
        +
        +
        Returns:
        +
        true if the id token has been acquired and cached, false if the id token is not available
        +
        +
        • +
      + + + +
        +
      • +

        isDeviceRegistered

        +
        boolean isDeviceRegistered()
        +
        Checks if the device has already been registered.
        +
        +
        Returns:
        +
        true if device registered has already completed and a client cert chain and ID token are present in the token store. + false if registration is required.
        +
        +
        • +
      + + + +
        +
      • +

        authorize

        +
        void authorize(java.lang.String url,
+               android.os.ResultReceiver resultReceiver)
        +
        Performs a remote authorization with the provider URL. (For Example QRCode)
        +
        +
        Parameters:
        +
        url - The temporary URL to enable the remote session.
        +
        resultReceiver - the resultReceiver to notify when a response is available, or if there is an error. Required.
        +
        +
        • +
      + + + +
        +
      • +

        getAuthenticationProvider

        +
        AuthenticationProvider getAuthenticationProvider()
+                                          throws java.lang.Exception
        +
        Retrieves the Authentication Providers from the server. + Authentication providers will not be retrieved if the user is already authenticated.
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSsoConfig.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSsoConfig.html new file mode 100644 index 00000000..7f778c42 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSsoConfig.html @@ -0,0 +1,992 @@ + + + + + +MobileSsoConfig + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core
+

Interface MobileSsoConfig

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PROP_TOKEN_HOSTNAME

        +
        static final java.lang.String PROP_TOKEN_HOSTNAME
        +
        String. The token server hostname or IP address, eg "oauth.example.com". Required.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URI_PREFIX

        +
        static final java.lang.String PROP_TOKEN_URI_PREFIX
        +
        String. URI prefix to include on token server URIs, eg "/someprefix". Optional.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_PORT_HTTP

        +
        static final java.lang.String PROP_TOKEN_PORT_HTTP
        +
        Integer. HTTP port on token server, eg 8080. Optional.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_PORT_HTTPS

        +
        static final java.lang.String PROP_TOKEN_PORT_HTTPS
        +
        Integer. HTTPS port on token server, eg 8443. Optional.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_ORGANIZATION

        +
        static final java.lang.String PROP_ORGANIZATION
        +
        String. The organization name to include in the client cert DN, eg "Exampletronics Ltd". Required.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_CLIENT_CERT_RSA_KEYBITS

        +
        static final java.lang.String PROP_CLIENT_CERT_RSA_KEYBITS
        +
        Integer. The size in bits of the RSA keypair to generate for the client cert, eg 2048. Optional.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_OAUTH_SCOPE

        +
        static final java.lang.String PROP_OAUTH_SCOPE
        +
        String. The OAuth scope string that should be requested when obtaining an access token that will be used + to consume service from an API endpoint. If not provided, a default value will be used.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_CLIENT_ID

        +
        static final java.lang.String PROP_CLIENT_ID
        +
        String. The application's client id for the initial OAuth token request, eg "846955e8-a8fb-4bea-bdd7-a16b39770c3d". Required.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_CLIENT_SECRET

        +
        static final java.lang.String PROP_CLIENT_SECRET
        +
        String. The application's client secret for the initial OAuth token request, eg "6ed4ffcb-4110-4c68-b280-cda17f127374".
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_SSO_ENABLED

        +
        static final java.lang.String PROP_SSO_ENABLED
        +
        Boolean. Check if single sign on should be used for this app. +

        + If single sign on is enabled, then we will check for a JWT in the token store and use it + if it is available; we will also save any JWT we obtain from the token server into the token store. +

        + If single sign on is not enabled, we will ignore any JWT in the token store and will not save any JWTs + to the token store. +

        + True if single sign on is enabled, and shared JWTs should be used. False if shared JWTs should not be used.

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_RESPONSE_BUFFERING_ENABLED

        +
        static final java.lang.String PROP_RESPONSE_BUFFERING_ENABLED
        +
        Boolean, default=true. Check if responses will be fully read and buffered before the result receiver is notified + of the response. +

        + This can be set to false to pass the response back immediately, before its body has been read. + The receiver of the response can then stream a large response without buffering, but is then + responsible for ensuring they do not do so while blocking the UI thread.

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_RESPONSE_BUFFERING_MAX_SIZE

        +
        static final java.lang.String PROP_RESPONSE_BUFFERING_MAX_SIZE
        +
        Integer, default=10485760. Maximum size of response that will be buffered in RAM if response buffering + is enabled.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_LOCATION_ENABLED

        +
        static final java.lang.String PROP_LOCATION_ENABLED
        +
        Boolean. Check if location information should be included in outbound requests. +

        + If location is enabled, outbound HTTP requests will include a "geo-location" HTTP header whose value + is in the format "latitude,longitude,extra". The latitude and longitude will always be present + (as decimal numbers). One or more additional comma-delimited values may be present after the longitude. + + True if location information should be included. False if location information should not be included.

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_LOCATION_PROVIDER_NAME

        +
        static final java.lang.String PROP_LOCATION_PROVIDER_NAME
        +
        String. Get the location provider to use if location is enabled. +

        + Location headers will not be included if the permission is lacking to use the specified location provider. +

        + The location provider name, ie "network", or null to allow the policy to select a default provider.

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TRUSTED_PUBLIC_PKI

        +
        static final java.lang.String PROP_TRUSTED_PUBLIC_PKI
        +
        Boolean. Controls whether public CAs recognized by the OS should be accepted as TLS server certs in addition + to the list returned by PROP_TRUSTED_CERTS_PEM. +

        + true if public CAs known to the OS should be trusted for outbound TLS. + false if only the certs returned by PROP_TRUSTED_CERTS_PEM should be trusted.

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TRUSTED_CERTS_PEM

        +
        static final java.lang.String PROP_TRUSTED_CERTS_PEM
        +
        ArrayList of String. Configures the server certificate trust anchors that should be trusted for outbound TLS. +

        + If PROP_TRUSTED_PUBLIC_PKI is false then only TLS server certs on this list + (or directly or indirectly signed by certs on this list) will be trusted for outbound TLS. +

        + The value is an ArrayList of String where each entry is a certificate trust anchor in PEM format + (eg, starting with "-----BEGIN CERTIFICATE-----\n").

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TRUSTED_CERT_PINNED_PUBLIC_KEY_HASHES

        +
        static final java.lang.String PROP_TRUSTED_CERT_PINNED_PUBLIC_KEY_HASHES
        +
        ArrayList of String. Controls whether TLS server certificate public key pinning is in use and, if so, what pinned + public key hashes to permit within server cert chains. +

        + This is only really useful if PROP_TRUSTED_PUBLIC_PKI is true. If you don't trust public + PKI certs and are relying on internal PKI or self-signed certificates built into the app then you probably + do not need to worry about certificate pinning. +

        + If this list is nonempty then a TLS server cert will be accepted only if one of the pinned public keys + appears somewhere in its certificate chain. +

        + This prevents CAs -- any public CA, not necessarily the CA that signed the server cert originally -- from being + able to create a forged server certificate for an arbitrary target domain. +

        + The value is an ArrayList of pinned server certificate public keys, expressed as hexadecimal Strings. + Each value is the lowercase hex dump of an SHA-256 hash of a SubjectPublicKeyInfo structure. + This value should be null if public key pinning should not be used.

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URL_SUFFIX_REQUEST_TOKEN

        +
        static final java.lang.String PROP_TOKEN_URL_SUFFIX_REQUEST_TOKEN
        +
        String. URL suffix for token server's request_token endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to request an access_token/id_token (JWT) + using username/password credentials. +

        + If not specified, will default to "/auth/oauth/v2/token".

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URL_SUFFIX_REQUEST_TOKEN_SSO

        +
        static final java.lang.String PROP_TOKEN_URL_SUFFIX_REQUEST_TOKEN_SSO
        +
        String. URL suffix for token server's request_token_sso endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to request an access_token usin gan ID token (JWT). +

        + If not specified, will default to "/auth/oauth/v2/token" (the same as + the regular request_token endpoint).

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URL_SUFFIX_REGISTER_DEVICE

        +
        static final java.lang.String PROP_TOKEN_URL_SUFFIX_REGISTER_DEVICE
        +
        String. URL suffix for token server's register_device endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to register the device the first time it is used. +

        + If not specified, will default to "/connect/device/register".

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URL_SUFFIX_RENEW_DEVICE

        +
        static final java.lang.String PROP_TOKEN_URL_SUFFIX_RENEW_DEVICE
        +
        String. URL suffix for token server's renew_device endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to renew the device if client certificate has expired. +

        + If not specified, will default to "/connect/device/renew".

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URL_SUFFIX_REGISTER_DEVICE_CLIENT

        +
        static final java.lang.String PROP_TOKEN_URL_SUFFIX_REGISTER_DEVICE_CLIENT
        +
        String. URL suffix for token server's register_device_client endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to register the device the first time it is used. +

        + If not specified, will default to "/connect/device/register/client".

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URL_SUFFIX_RESOURCE_OWNER_LOGOUT

        +
        static final java.lang.String PROP_TOKEN_URL_SUFFIX_RESOURCE_OWNER_LOGOUT
        +
        String. URL suffix for token server's resource_owner_logout endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to log out the current device + by invalidating the ID token (JWT). +

        + If not specified, will default to "/connect/session/logout".

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URL_SUFFIX_REMOVE_DEVICE_X509

        +
        static final java.lang.String PROP_TOKEN_URL_SUFFIX_REMOVE_DEVICE_X509
        +
        String. URL suffix for token server's remove_device_x509 endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to remove the current + device registration, identifying the device by its TLS client certificate. +

        + If not specified, will default to "/connect/device/remove".

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URL_SUFFIX_AUTHORIZE

        +
        static final java.lang.String PROP_TOKEN_URL_SUFFIX_AUTHORIZE
        +
        String. URL suffix for token server's authorize endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to request for Social login + using authorization_code credentials. +

        + If not specified, will default to "/auth/oauth/v2/authorize".

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URL_SUFFIX_ENTERPRISE_APPS

        +
        static final java.lang.String PROP_TOKEN_URL_SUFFIX_ENTERPRISE_APPS
        +
        String. URL suffix for server's enterprise apps endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to request for + enterprise apps. +

        + If not specified, will default to "/connect/enterprise/browser".

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_AUTHORIZE_REDIRECT_URI

        +
        static final java.lang.String PROP_AUTHORIZE_REDIRECT_URI
        +
        String. The redirect URI that provided to the third-party-login platform. +

        + If not specified, will default to null, and third-party-login will not be supported.

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_MSISDN_ENABLED

        +
        static final java.lang.String PROP_MSISDN_ENABLED
        +
        Boolean. Check if MSISDN information should be included in the outbound requests. +

        + If MSISDN is enabled, outbound HTTP requests will include a "MSISDN" HTTP header whose value + is in the phone number string, the MSISDN for a GSM phone. Return null if is unavailable + + True if MSISDN information should be included. False if MSISDN information should not be included.

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_TOKEN_URL_SUFFIX_CLIENT_CREDENTIALS

        +
        static final java.lang.String PROP_TOKEN_URL_SUFFIX_CLIENT_CREDENTIALS
        +
        String. URL suffix for client credentials endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to request for + client credentials. +

        + If not specified, will default to "/connect/client/initialize".

        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        AUTHENTICATE_OTP_PATH

        +
        static final java.lang.String AUTHENTICATE_OTP_PATH
        +
        String. URL suffix for authenticate otp endpoint. + Used with PROP_TOKEN_URI_PREFIX to build the URL to request for + otp generation and delivery.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_BLE_SERVICE_UUID

        +
        static final java.lang.String PROP_BLE_SERVICE_UUID
        +
        String. The Service UUID for BluetoothLe to support cross-platform user session sharing.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_BLE_CHARACTERISTIC_UUID

        +
        static final java.lang.String PROP_BLE_CHARACTERISTIC_UUID
        +
        String. The Characteristic UUID for BluetoothLe to support cross-platform user session sharing.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_BLE_RSSI

        +
        static final java.lang.String PROP_BLE_RSSI
        +
        Integer. The received signal strength indication for BluetoothLe to support cross-platform user + session sharing.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_STORAGE

        +
        static final java.lang.String PROP_STORAGE
        +
        JSON String. This represents the storage (and its default properties) to use + by the SDK for persistence. + "storage": { + "class": "<Canonical name of the Storage class>", + "share" "true/false" + } +
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSsoFactory.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSsoFactory.html new file mode 100644 index 00000000..3947ab76 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSsoFactory.html @@ -0,0 +1,488 @@ + + + + + +MobileSsoFactory + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core
+

Class MobileSsoFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.MobileSsoFactory
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class MobileSsoFactory
+extends java.lang.Object
    +
    Entry point for the Mobile SSO SDK.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static java.util.concurrent.atomic.AtomicReference<MobileSso>mobileSso 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private MobileSsoFactory() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private static MobileSsocreateMobileSso(android.content.Context context) 
      static MobileSsogetInstance() +
      Obtains the cached MobileSso instance.
      +
      static MobileSsogetInstance(android.content.Context context) +
      Obtains and initializes the MobileSso instance using the specified Context.
      +
      static MobileSsogetInstance(android.content.Context context, + boolean forceDefault) +
      Obtains and initializes the MobileSso instance using the specified Context.
      +
      static MobileSsogetInstance(android.content.Context context, + org.json.JSONObject config) +
      Obtains and initializes the MobileSso instance using the specified Context and configuration JSONObject.
      +
      static MobileSsogetInstance(android.content.Context context, + java.net.URL url) +
      Obtains and initializes the MobileSso instance using the specified Context and file.
      +
      private static booleanisSwitchGateway(org.json.JSONObject newConfig) 
      static voidreset() +
      Resets the initialized MobileSso.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        mobileSso

        +
        private static final java.util.concurrent.atomic.AtomicReference<MobileSso> mobileSso
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MobileSsoFactory

        +
        private MobileSsoFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getInstance

        +
        public static MobileSso getInstance(@NonNull
+                                    android.content.Context context,
+                                    boolean forceDefault)
        +

        Obtains and initializes the MobileSso instance using the specified Context.

        + If a MobileSso instance has already been created for this process, it will be returned. + Otherwise, a new MobileSso instance will be created using the specified context and last + active JSON Configuration file.
        +
        +
        Parameters:
        +
        context - Context to provide access to services such as the device ID and current location. Required.
        +
        forceDefault - True - force to load the JSON Configuration under /assets/msso_config.json
        +
        Returns:
        +
        a MobileSso implementation. Never null.
        +
        +
        • +
      + + + +
        +
      • +

        getInstance

        +
        public static MobileSso getInstance(@NonNull
+                                    android.content.Context context)
        +

        Obtains and initializes the MobileSso instance using the specified Context.

        + If a MobileSso instance has already been created for this process, it will be returned. + Otherwise, a new MobileSso instance will be created using the specified context and last + active JSON Configuration file.
        +
        +
        Parameters:
        +
        context - Context to provide access to services such as the device ID and current location. Required.
        +
        Returns:
        +
        a MobileSso implementation. Never null.
        +
        +
        • +
      + + + +
        +
      • +

        getInstance

        +
        public static MobileSso getInstance(@NonNull
+                                    android.content.Context context,
+                                    @NonNull
+                                    java.net.URL url)
        +

        Obtains and initializes the MobileSso instance using the specified Context and file.

        +

        If a MobileSso instance has already been created with the same host, port and prefix for this process, + it will be returned, otherwise, a new MobileSso instance will be created using the specified + context and JSONObject. Multiple MobileSso with different configuration is not currently supported, + Application should not use more than one instance of MobileSso with different setting. +

        +

        You should use this method cautiously at runtime as an exception may be thrown due to an invalid + JSON Object, missing mandatory value, invalid types, etc. You may use a try and catch block + to avoid applications from being unexpectedly killed. +

        +
        +
        Parameters:
        +
        context - Context to provide access to services such as the device ID and current location. Required.
        +
        url - URL of JSON configuration to use, if a MobileSso has not yet been created for this process. Required.
        +
        Returns:
        +
        a MobileSso implementation. Never null.
        +
        +
        • +
      + + + +
        +
      • +

        getInstance

        +
        public static MobileSso getInstance(@NonNull
+                                    android.content.Context context,
+                                    @NonNull
+                                    org.json.JSONObject config)
        +

        Obtains and initializes the MobileSso instance using the specified Context and configuration JSONObject.

        +

        If a MobileSso instance has already been created with the same host, port and prefix for this process, + it will be returned, otherwise, a new MobileSso instance will be created using the specified + context and JSONObject. Multiple MobileSso with different configuration is not currently supported, + Application should not use more than one instance of MobileSso with different setting. +

        +

        You should use this method cautiously at runtime as an exception may be thrown due to an invalid + JSON Object, missing mandatory value, invalid types, etc. You may use a try and catch block + to avoid applications from being unexpectedly killed. +

        +
        +
        Parameters:
        +
        context - Context to provide access to services such as the device ID and current location. Required.
        +
        config - JSON configuration to use, if a MobileSso has not yet been created for this process. Required.
        +
        Returns:
        +
        a MobileSso implementation. Never null.
        +
        +
        • +
      + + + +
        +
      • +

        isSwitchGateway

        +
        private static boolean isSwitchGateway(org.json.JSONObject newConfig)
        +
        • +
      + + + +
        +
      • +

        reset

        +
        public static void reset()
        +
        Resets the initialized MobileSso. If a MobileSso instance has already been created for this process, it + will be reset, and a new MobileSso instance will be created during the next call of + getInstance() or getInstance(Context, JSONObject)
        +
        • +
      + + + +
        +
      • +

        createMobileSso

        +
        private static MobileSso createMobileSso(android.content.Context context)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSsoListener.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSsoListener.html new file mode 100644 index 00000000..e2116a5d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/MobileSsoListener.html @@ -0,0 +1,250 @@ + + + + + +MobileSsoListener + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core
+

Interface MobileSsoListener

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    AuthenticationListener
    +
    +
    +
    +
    public interface MobileSsoListener
    +
    Interface that will receive various notifications and requests for the MAG client.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onAuthenticateRequest

        +
        void onAuthenticateRequest(long requestId,
+                           AuthenticationProvider authenticationProvider)
        +
        Notifies the host application that a request to authenticate is triggered by the MAG authentication process.
        +
        +
        Parameters:
        +
        requestId -
        +
        authenticationProvider -
        +
        +
        • +
      + + + +
        +
      • +

        onOtpAuthenticationRequest

        +
        void onOtpAuthenticationRequest(MASOtpAuthenticationHandler otpAuthenticationHandler)
        +
        Deprecated. 
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/AuthRenderer.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/AuthRenderer.html new file mode 100644 index 00000000..232e1056 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/AuthRenderer.html @@ -0,0 +1,505 @@ + + + + + +AuthRenderer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth
+

Class AuthRenderer

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.auth.AuthRenderer
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    PollingRenderer
    +
    +
    +
    +
    public abstract class AuthRenderer
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      AuthRenderer() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      abstract voidclose() +
      Perform clean up for the renderer.
      +
      java.lang.StringgetId() +
      Retrieve the ID of the Auth Provider, the auth provider should be one of the provider returned from the authorize + endpoint MobileSsoConfig.PROP_TOKEN_URL_SUFFIX_AUTHORIZE.
      +
      booleaninit(android.content.Context context, + Provider provider) +
      Initialize the Renderer,
      +
      (package private) abstract voidonAuthCodeReceived(java.lang.String code, + java.lang.String state) +
      Notify the Authenticate Renderer that Authorization code has been retrieved.
      +
      protected abstract voidonError(int code, + java.lang.String message, + java.lang.Exception e) +
      Notify when any error occur.
      +
      abstract voidonRenderCompleted() +
      Perform action after rendering is completed.
      +
      protected voidproceed() +
      Proceed the authorization process and retrieve the authorized Authorization Code.
      +
      abstract android.view.Viewrender() +
      Render the view for the login, the view can be a image, button or null for no view.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + + + + + +
        +
      • +

        context

        +
        protected android.content.Context context
        +
        • +
      + + + +
        +
      • +

        provider

        +
        protected Provider provider
        +
        • +
      + + + +
        +
      • +

        requestId

        +
        protected long requestId
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AuthRenderer

        +
        public AuthRenderer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        init

        +
        public boolean init(android.content.Context context,
+                    Provider provider)
        +
        Initialize the Renderer,
        +
        +
        Parameters:
        +
        context - The application context
        +
        provider - The Authorize Provider returned from gateway
        +
        Returns:
        +
        True if init success, False when failed to init the renderer, the renderer will not be + added to as One of the Touch less login.
        +
        +
        • +
      + + + +
        +
      • +

        getId

        +
        public java.lang.String getId()
        +
        Retrieve the ID of the Auth Provider, the auth provider should be one of the provider returned from the authorize + endpoint MobileSsoConfig.PROP_TOKEN_URL_SUFFIX_AUTHORIZE.
        +
        +
        Returns:
        +
        Return the id of auth provider
        +
        +
        • +
      + + + +
        +
      • +

        render

        +
        public abstract android.view.View render()
        +
        Render the view for the login, the view can be a image, button or null for no view. + The view will put to the login dialog as one of the login provider.
        +
        +
        Returns:
        +
        The login view to represent the login action.
        +
        +
        • +
      + + + +
        +
      • +

        onRenderCompleted

        +
        public abstract void onRenderCompleted()
        +
        Perform action after rendering is completed.
        +
        • +
      + + + +
        +
      • +

        onError

        +
        protected abstract void onError(int code,
+                                java.lang.String message,
+                                java.lang.Exception e)
        +
        Notify when any error occur.
        +
        +
        Parameters:
        +
        code - Error code
        +
        message - Error message
        +
        e - Exception
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public abstract void close()
        +
        Perform clean up for the renderer.
        +
        • +
      + + + +
        +
      • +

        proceed

        +
        protected void proceed()
        +
        Proceed the authorization process and retrieve the authorized Authorization Code.
        +
        • +
      + + + +
        +
      • +

        onAuthCodeReceived

        +
        abstract void onAuthCodeReceived(java.lang.String code,
+                                 java.lang.String state)
        +
        Notify the Authenticate Renderer that Authorization code has been retrieved.
        +
        +
        Parameters:
        +
        code - Authorization Code
        +
        state - State from the response
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/AuthResultReceiver.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/AuthResultReceiver.html new file mode 100644 index 00000000..f498d74b --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/AuthResultReceiver.html @@ -0,0 +1,225 @@ + + + + + +AuthResultReceiver + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.auth
+

Interface AuthResultReceiver

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setData

        +
        void setData(org.json.JSONObject data)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/AuthenticationException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/AuthenticationException.html new file mode 100644 index 00000000..a7033406 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/AuthenticationException.html @@ -0,0 +1,355 @@ + + + + + +AuthenticationException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth
+

Class AuthenticationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class AuthenticationException
+extends MAGServerException
    +
    This exception is thrown when an authentication error occurs while accessing the MAG Server register or token endpoint.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        INVALID_RESOURCE_OWNER_SUFFIX

        +
        public static final java.lang.String INVALID_RESOURCE_OWNER_SUFFIX
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AuthenticationException

        +
        public AuthenticationException(MASResponse response,
+                               int errorCode,
+                               int status,
+                               java.lang.String contentType,
+                               java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        AuthenticationException

        +
        public AuthenticationException(MASResponse response,
+                               int errorCode,
+                               int status,
+                               java.lang.String contentType,
+                               java.lang.String detailMessage,
+                               java.lang.Throwable throwable)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/NFCRenderer.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/NFCRenderer.html new file mode 100644 index 00000000..e9570841 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/NFCRenderer.html @@ -0,0 +1,622 @@ + + + + + +NFCRenderer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth
+

Class NFCRenderer

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        NFC_ERR

        +
        public static final int NFC_ERR
        +
        Error when NFC is not available
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLUETOOTH_ERR

        +
        public static final int BLUETOOTH_ERR
        +
        Error when unable to start Bluetooth Service
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLUETOOTH_CONN_ERR

        +
        public static final int BLUETOOTH_CONN_ERR
        +
        Error when failed to start Bluetooth server
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + +
        +
      • +

        PROVIDER_URL

        +
        public static final java.lang.String PROVIDER_URL
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        serverUuid

        +
        private java.util.UUID serverUuid
        +
        • +
      + + + +
        +
      • +

        adapter

        +
        private android.nfc.NfcAdapter adapter
        +
        • +
      + + + +
        +
      • +

        serverAddress

        +
        private java.lang.String serverAddress
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NFCRenderer

        +
        public NFCRenderer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        render

        +
        public android.view.View render()
        +
        Description copied from class: AuthRenderer
        +
        Render the view for the login, the view can be a image, button or null for no view. + The view will put to the login dialog as one of the login provider.
        +
        +
        Specified by:
        +
        render in class AuthRenderer
        +
        Returns:
        +
        The login view to represent the login action.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        onError

        +
        protected void onError(int code,
+                       java.lang.String message,
+                       java.lang.Exception e)
        +
        Description copied from class: AuthRenderer
        +
        Notify when any error occur.
        +
        +
        Specified by:
        +
        onError in class AuthRenderer
        +
        Parameters:
        +
        code - Error code
        +
        message - Error message
        +
        e - Exception
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from class: AuthRenderer
        +
        Perform clean up for the renderer.
        +
        +
        Overrides:
        +
        close in class PollingRenderer
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/NfcResultReceiver.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/NfcResultReceiver.html new file mode 100644 index 00000000..f9aae2ae --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/NfcResultReceiver.html @@ -0,0 +1,382 @@ + + + + + +NfcResultReceiver + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth
+

Class NfcResultReceiver

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.os.Parcelable, AuthResultReceiver
    +
    +
    +
    +
    public abstract class NfcResultReceiver
+extends MAGResultReceiver
+implements AuthResultReceiver
    +
    The default NFC result receiver. To avoid polling the MAG, this receiver will notify + the session request device after it successfully authenticates the user session.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface android.os.Parcelable

        +android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private org.json.JSONObjectdata 
      +
        +
      • + + +

        Fields inherited from class android.os.ResultReceiver

        +CREATOR
        • +
      +
        +
      • + + +

        Fields inherited from interface android.os.Parcelable

        +CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      NfcResultReceiver() 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        data

        +
        private org.json.JSONObject data
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NfcResultReceiver

        +
        public NfcResultReceiver()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getData

        +
        public org.json.JSONObject getData()
        +
        • +
      + + + +
        +
      • +

        setData

        +
        public void setData(org.json.JSONObject data)
        +
        +
        Specified by:
        +
        setData in interface AuthResultReceiver
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/PollingRenderer.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/PollingRenderer.html new file mode 100644 index 00000000..8046e50b --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/PollingRenderer.html @@ -0,0 +1,623 @@ + + + + + +PollingRenderer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth
+

Class PollingRenderer

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PollingRenderer() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Perform clean up for the renderer.
      +
      protected longgetDelay() +
      The time to delay first execution.
      +
      protected longgetMaxPollCount() +
      The maximum number of polls
      +
      protected longgetPollInterval() +
      The interval between the termination of one + execution and the commencement of the next
      +
      booleaninit(android.content.Context context, + Provider provider) +
      Initialize the Renderer,
      +
      protected voidonAuthCodeReceived(java.lang.String code, + java.lang.String state) +
      Notify the Authenticate Renderer that Authorization code has been retrieved.
      +
      voidonRenderCompleted() +
      Perform action after rendering is completed.
      +
      protected voidpoll() +
      Start the polling
      +
      protected abstract booleanstartPollingOnStartup() +
      Start polling MAG on startup
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        INVALID_SESSION_ID_OR_POLL_URL

        +
        public static final int INVALID_SESSION_ID_OR_POLL_URL
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        SESSION_EXPIRED

        +
        public static final int SESSION_EXPIRED
        +
        Error due to errors occurred during request for auth code. + The session is expired
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        POLL_INTERVAL

        +
        public static final int POLL_INTERVAL
        +
        Default Poll Interval
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        MAX_POLL_COUNT

        +
        public static final int MAX_POLL_COUNT
        +
        Default Maximum number of polls
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DELAY

        +
        public static final int DELAY
        +
        Default delay for the first execution
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        task

        +
        private java.util.TimerTask task
        +
        • +
      + + + +
        +
      • +

        timer

        +
        private java.util.concurrent.ScheduledExecutorService timer
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PollingRenderer

        +
        public PollingRenderer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        init

        +
        public boolean init(android.content.Context context,
+                    Provider provider)
        +
        Description copied from class: AuthRenderer
        +
        Initialize the Renderer,
        +
        +
        Overrides:
        +
        init in class AuthRenderer
        +
        Parameters:
        +
        context - The application context
        +
        provider - The Authorize Provider returned from gateway
        +
        Returns:
        +
        True if init success, False when failed to init the renderer, the renderer will not be + added to as One of the Touch less login.
        +
        +
        • +
      + + + +
        +
      • +

        onRenderCompleted

        +
        public void onRenderCompleted()
        +
        Description copied from class: AuthRenderer
        +
        Perform action after rendering is completed.
        +
        +
        Specified by:
        +
        onRenderCompleted in class AuthRenderer
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from class: AuthRenderer
        +
        Perform clean up for the renderer.
        +
        +
        Specified by:
        +
        close in class AuthRenderer
        +
        +
        • +
      + + + +
        +
      • +

        poll

        +
        protected void poll()
        +
        Start the polling
        +
        • +
      + + + +
        +
      • +

        getPollInterval

        +
        protected long getPollInterval()
        +
        The interval between the termination of one + execution and the commencement of the next
        +
        +
        Returns:
        +
        the interval between the termination of one + execution and the commencement of the next
        +
        +
        • +
      + + + +
        +
      • +

        getMaxPollCount

        +
        protected long getMaxPollCount()
        +
        The maximum number of polls
        +
        +
        Returns:
        +
        The maximum number of polls
        +
        +
        • +
      + + + +
        +
      • +

        getDelay

        +
        protected long getDelay()
        +
        The time to delay first execution.
        +
        +
        Returns:
        +
        the time to delay first execution.
        +
        +
        • +
      + + + +
        +
      • +

        onAuthCodeReceived

        +
        protected void onAuthCodeReceived(java.lang.String code,
+                                  java.lang.String state)
        +
        Description copied from class: AuthRenderer
        +
        Notify the Authenticate Renderer that Authorization code has been retrieved.
        +
        +
        Specified by:
        +
        onAuthCodeReceived in class AuthRenderer
        +
        Parameters:
        +
        code - Authorization Code
        +
        state - State from the response
        +
        +
        • +
      + + + +
        +
      • +

        startPollingOnStartup

        +
        protected abstract boolean startPollingOnStartup()
        +
        Start polling MAG on startup
        +
        +
        Returns:
        +
        True to start polling when after AuthRenderer.onRenderCompleted()
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/QRCode.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/QRCode.html new file mode 100644 index 00000000..44259650 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/QRCode.html @@ -0,0 +1,301 @@ + + + + + +QRCode + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.auth
+

Class QRCode

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • android.view.View
      • +
    • +
        +
      • android.widget.ImageView
        • +
      • +
          +
        • com.ca.mas.core.auth.QRCode
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.graphics.drawable.Drawable.Callback, android.view.accessibility.AccessibilityEventSource, android.view.KeyEvent.Callback
    +
    +
    +
    +
    public class QRCode
+extends android.widget.ImageView
    +
    A QRCode ImageView
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.widget.ImageView

        +android.widget.ImageView.ScaleType
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.view.View

        +android.view.View.AccessibilityDelegate, android.view.View.BaseSavedState, android.view.View.DragShadowBuilder, android.view.View.MeasureSpec, android.view.View.OnApplyWindowInsetsListener, android.view.View.OnAttachStateChangeListener, android.view.View.OnCapturedPointerListener, android.view.View.OnClickListener, android.view.View.OnContextClickListener, android.view.View.OnCreateContextMenuListener, android.view.View.OnDragListener, android.view.View.OnFocusChangeListener, android.view.View.OnGenericMotionListener, android.view.View.OnHoverListener, android.view.View.OnKeyListener, android.view.View.OnLayoutChangeListener, android.view.View.OnLongClickListener, android.view.View.OnScrollChangeListener, android.view.View.OnSystemUiVisibilityChangeListener, android.view.View.OnTouchListener
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class android.view.View

        +ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR, AUTOFILL_HINT_CREDIT_CARD_NUMBER, AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE, AUTOFILL_HINT_EMAIL_ADDRESS, AUTOFILL_HINT_NAME, AUTOFILL_HINT_PASSWORD, AUTOFILL_HINT_PHONE, AUTOFILL_HINT_POSTAL_ADDRESS, AUTOFILL_HINT_POSTAL_CODE, AUTOFILL_HINT_USERNAME, AUTOFILL_TYPE_DATE, AUTOFILL_TYPE_LIST, AUTOFILL_TYPE_NONE, AUTOFILL_TYPE_TEXT, AUTOFILL_TYPE_TOGGLE, DRAG_FLAG_GLOBAL, DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION, DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION, DRAG_FLAG_GLOBAL_URI_READ, DRAG_FLAG_GLOBAL_URI_WRITE, DRAG_FLAG_OPAQUE, DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, EMPTY_STATE_SET, ENABLED_FOCUSED_SELECTED_STATE_SET, ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_FOCUSED_STATE_SET, ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, ENABLED_SELECTED_STATE_SET, ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_STATE_SET, ENABLED_WINDOW_FOCUSED_STATE_SET, FIND_VIEWS_WITH_CONTENT_DESCRIPTION, FIND_VIEWS_WITH_TEXT, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUSABLE, FOCUSABLE_AUTO, FOCUSABLES_ALL, FOCUSABLES_TOUCH_MODE, FOCUSED_SELECTED_STATE_SET, FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, FOCUSED_STATE_SET, FOCUSED_WINDOW_FOCUSED_STATE_SET, GONE, HAPTIC_FEEDBACK_ENABLED, IMPORTANT_FOR_ACCESSIBILITY_AUTO, IMPORTANT_FOR_ACCESSIBILITY_NO, IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, IMPORTANT_FOR_ACCESSIBILITY_YES, IMPORTANT_FOR_AUTOFILL_AUTO, IMPORTANT_FOR_AUTOFILL_NO, IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS, IMPORTANT_FOR_AUTOFILL_YES, IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, INVISIBLE, KEEP_SCREEN_ON, LAYER_TYPE_HARDWARE, LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE, LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, MEASURED_HEIGHT_STATE_SHIFT, MEASURED_SIZE_MASK, MEASURED_STATE_MASK, MEASURED_STATE_TOO_SMALL, NO_ID, NOT_FOCUSABLE, OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS, OVER_SCROLL_NEVER, PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_SELECTED_STATE_SET, PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_STATE_SET, PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_SELECTED_STATE_SET, PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_STATE_SET, PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_SELECTED_STATE_SET, PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_STATE_SET, PRESSED_WINDOW_FOCUSED_STATE_SET, ROTATION, ROTATION_X, ROTATION_Y, SCALE_X, SCALE_Y, SCREEN_STATE_OFF, SCREEN_STATE_ON, SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_NONE, SCROLL_AXIS_VERTICAL, SCROLL_INDICATOR_BOTTOM, SCROLL_INDICATOR_END, SCROLL_INDICATOR_LEFT, SCROLL_INDICATOR_RIGHT, SCROLL_INDICATOR_START, SCROLL_INDICATOR_TOP, SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT, SCROLLBAR_POSITION_RIGHT, SCROLLBARS_INSIDE_INSET, SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_OUTSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY, SELECTED_STATE_SET, SELECTED_WINDOW_FOCUSED_STATE_SET, SOUND_EFFECTS_ENABLED, STATUS_BAR_HIDDEN, STATUS_BAR_VISIBLE, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_IMMERSIVE, SYSTEM_UI_FLAG_IMMERSIVE_STICKY, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR, SYSTEM_UI_FLAG_LIGHT_STATUS_BAR, SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_VISIBLE, SYSTEM_UI_LAYOUT_FLAGS, TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_GRAVITY, TEXT_ALIGNMENT_INHERIT, TEXT_ALIGNMENT_TEXT_END, TEXT_ALIGNMENT_TEXT_START, TEXT_ALIGNMENT_VIEW_END, TEXT_ALIGNMENT_VIEW_START, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_FIRST_STRONG_LTR, TEXT_DIRECTION_FIRST_STRONG_RTL, TEXT_DIRECTION_INHERIT, TEXT_DIRECTION_LOCALE, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TRANSLATION_X, TRANSLATION_Y, TRANSLATION_Z, VIEW_LOG_TAG, VISIBLE, WINDOW_FOCUSED_STATE_SET, X, Y, Z
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      QRCode(android.content.Context context) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class android.widget.ImageView

        +clearColorFilter, drawableHotspotChanged, drawableStateChanged, getAccessibilityClassName, getAdjustViewBounds, getBaseline, getBaselineAlignBottom, getColorFilter, getCropToPadding, getDrawable, getImageAlpha, getImageMatrix, getImageTintList, getImageTintMode, getMaxHeight, getMaxWidth, getScaleType, hasOverlappingRendering, invalidateDrawable, isOpaque, jumpDrawablesToCurrentState, onAttachedToWindow, onCreateDrawableState, onDetachedFromWindow, onDraw, onMeasure, onRtlPropertiesChanged, onVisibilityAggregated, setAdjustViewBounds, setAlpha, setBaseline, setBaselineAlignBottom, setColorFilter, setColorFilter, setColorFilter, setCropToPadding, setFrame, setImageAlpha, setImageBitmap, setImageDrawable, setImageIcon, setImageLevel, setImageMatrix, setImageResource, setImageState, setImageTintList, setImageTintMode, setImageURI, setMaxHeight, setMaxWidth, setScaleType, setSelected, setVisibility, verifyDrawable
        • +
      +
        +
      • + + +

        Methods inherited from class android.view.View

        +addChildrenForAccessibility, addExtraDataToAccessibilityNodeInfo, addFocusables, addFocusables, addKeyboardNavigationClusters, addOnAttachStateChangeListener, addOnLayoutChangeListener, addTouchables, animate, announceForAccessibility, autofill, autofill, awakenScrollBars, awakenScrollBars, awakenScrollBars, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, cancelDragAndDrop, cancelLongPress, cancelPendingInputEvents, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, checkInputConnectionProxy, clearAnimation, clearFocus, combineMeasuredStates, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeScroll, computeSystemWindowInsets, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchApplyWindowInsets, dispatchCapturedPointerEvent, dispatchConfigurationChanged, dispatchDisplayHint, dispatchDragEvent, dispatchDraw, dispatchDrawableHotspotChanged, dispatchFinishTemporaryDetach, dispatchGenericFocusedEvent, dispatchGenericMotionEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPointerCaptureChanged, dispatchPopulateAccessibilityEvent, dispatchProvideAutofillStructure, dispatchProvideStructure, dispatchRestoreInstanceState, dispatchSaveInstanceState, dispatchSetActivated, dispatchSetPressed, dispatchSetSelected, dispatchStartTemporaryDetach, dispatchSystemUiVisibilityChanged, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchVisibilityChanged, dispatchWindowFocusChanged, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, draw, findFocus, findViewById, findViewsWithText, findViewWithTag, fitSystemWindows, focusSearch, forceHasOverlappingRendering, forceLayout, generateViewId, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAlpha, getAnimation, getApplicationWindowToken, getAutofillHints, getAutofillId, getAutofillType, getAutofillValue, getBackground, getBackgroundTintList, getBackgroundTintMode, getBottom, getBottomFadingEdgeStrength, getBottomPaddingOffset, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentDescription, getContext, getContextMenuInfo, getDefaultFocusHighlightEnabled, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusable, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintList, getForegroundTintMode, getGlobalVisibleRect, getGlobalVisibleRect, getHandler, getHasOverlappingRendering, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarHeight, getId, getImportantForAccessibility, getImportantForAutofill, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLeftFadingEdgeStrength, getLeftPaddingOffset, getLocalVisibleRect, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextClusterForwardId, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineProvider, getOverlay, getOverScrollMode, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPivotX, getPivotY, getPointerIcon, getResources, getRevealOnFocusHint, getRight, getRightFadingEdgeStrength, getRightPaddingOffset, getRootView, getRootWindowInsets, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollIndicators, getScrollX, getScrollY, getSolidColor, getStateListAnimator, getSuggestedMinimumHeight, getSuggestedMinimumWidth, getSystemUiVisibility, getTag, getTag, getTextAlignment, getTextDirection, getTooltipText, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchables, getTouchDelegate, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarWidth, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasExplicitFocusable, hasFocus, hasFocusable, hasNestedScrollingParent, hasOnClickListeners, hasPointerCapture, hasTransientState, hasWindowFocus, inflate, invalidate, invalidate, invalidate, invalidateOutline, isAccessibilityFocused, isActivated, isAttachedToWindow, isClickable, isContextClickable, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isFocusedByDefault, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isImportantForAutofill, isInEditMode, isInLayout, isInTouchMode, isKeyboardNavigationCluster, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isPaddingOffsetRequired, isPaddingRelative, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScrollbarFadingEnabled, isScrollContainer, isSelected, isShown, isSoundEffectsEnabled, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, keyboardNavigationClusterSearch, layout, measure, mergeDrawableStates, offsetLeftAndRight, offsetTopAndBottom, onAnimationEnd, onAnimationStart, onApplyWindowInsets, onCancelPendingInputEvents, onCapturedPointerEvent, onCheckIsTextEditor, onConfigurationChanged, onCreateContextMenu, onCreateInputConnection, onDisplayHint, onDragEvent, onDrawForeground, onDrawScrollBars, onFilterTouchEventForSecurity, onFinishInflate, onFinishTemporaryDetach, onFocusChanged, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onLayout, onOverScrolled, onPointerCaptureChange, onPopulateAccessibilityEvent, onProvideAutofillStructure, onProvideAutofillVirtualStructure, onProvideStructure, onProvideVirtualStructure, onResolvePointerIcon, onRestoreInstanceState, onSaveInstanceState, onScreenStateChanged, onScrollChanged, onSetAlpha, onSizeChanged, onStartTemporaryDetach, onTouchEvent, onTrackballEvent, onVisibilityChanged, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, onWindowVisibilityChanged, overScrollBy, performAccessibilityAction, performClick, performContextClick, performContextClick, performHapticFeedback, performHapticFeedback, performLongClick, performLongClick, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, postInvalidateOnAnimation, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, releasePointerCapture, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, requestApplyInsets, requestFitSystemWindows, requestFocus, requestFocus, requestFocus, requestFocusFromTouch, requestLayout, requestPointerCapture, requestRectangleOnScreen, requestRectangleOnScreen, requestUnbufferedDispatch, resolveSize, resolveSizeAndState, restoreDefaultFocus, restoreHierarchyState, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDelegate, setAccessibilityLiveRegion, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAlpha, setAnimation, setAutofillHints, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentDescription, setContextClickable, setDefaultFocusHighlightEnabled, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusable, setFocusableInTouchMode, setFocusedByDefault, setForeground, setForegroundGravity, setForegroundTintList, setForegroundTintMode, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHovered, setId, setImportantForAccessibility, setImportantForAutofill, setKeepScreenOn, setKeyboardNavigationCluster, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLongClickable, setMeasuredDimension, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextClusterForwardId, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnCapturedPointerListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineProvider, setOverScrollMode, setPadding, setPaddingRelative, setPivotX, setPivotY, setPointerIcon, setPressed, setRevealOnFocusHint, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollbarFadingEnabled, setScrollBarSize, setScrollBarStyle, setScrollContainer, setScrollIndicators, setScrollIndicators, setScrollX, setScrollY, setSoundEffectsEnabled, setStateListAnimator, setSystemUiVisibility, setTag, setTag, setTextAlignment, setTextDirection, setTooltipText, setTop, setTouchDelegate, setTransitionName, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, showContextMenu, startActionMode, startActionMode, startAnimation, startDrag, startDragAndDrop, startNestedScroll, stopNestedScroll, toString, unscheduleDrawable, unscheduleDrawable, updateDragShadow, willNotCacheDrawing, willNotDraw
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        QRCode

        +
        public QRCode(android.content.Context context)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/QRCodeRenderer.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/QRCodeRenderer.html new file mode 100644 index 00000000..28862fee --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/QRCodeRenderer.html @@ -0,0 +1,520 @@ + + + + + +QRCodeRenderer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth
+

Class QRCodeRenderer

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        QRCODE_ERROR

        +
        public static final int QRCODE_ERROR
        +
        Failed to generate QRCode error code
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        HEIGHT

        +
        private static final int HEIGHT
        +
        Default height of QRCode image
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        WIDTH

        +
        private static final int WIDTH
        +
        Default width of QRCode image
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        QRCodeRenderer

        +
        public QRCodeRenderer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toBitmap

        +
        private android.graphics.Bitmap toBitmap(com.google.zxing.common.BitMatrix matrix)
        +
        Writes the given Matrix on a new Bitmap object.
        +
        +
        Parameters:
        +
        matrix - the matrix to write.
        +
        Returns:
        +
        the new Bitmap-object.
        +
        +
        • +
      + + + +
        +
      • +

        render

        +
        public android.view.View render()
        +
        Description copied from class: AuthRenderer
        +
        Render the view for the login, the view can be a image, button or null for no view. + The view will put to the login dialog as one of the login provider.
        +
        +
        Specified by:
        +
        render in class AuthRenderer
        +
        Returns:
        +
        The login view to represent the login action.
        +
        +
        • +
      + + + +
        +
      • +

        onError

        +
        protected void onError(int code,
+                       java.lang.String m,
+                       java.lang.Exception e)
        +
        Description copied from class: AuthRenderer
        +
        Notify when any error occur.
        +
        +
        Specified by:
        +
        onError in class AuthRenderer
        +
        Parameters:
        +
        code - Error code
        +
        m - Error message
        +
        e - Exception
        +
        +
        • +
      + + + +
        +
      • +

        getQRCodeWidth

        +
        protected int getQRCodeWidth()
        +
        Retrieve the QRCode image width
        +
        +
        Returns:
        +
        Width of the QRCode
        +
        +
        • +
      + + + +
        +
      • +

        getQRCodeHeight

        +
        protected int getQRCodeHeight()
        +
        Retrieve the QRCode image height
        +
        +
        Returns:
        +
        Height of the QRCode
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLe.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLe.html new file mode 100644 index 00000000..c050d1f3 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLe.html @@ -0,0 +1,390 @@ + + + + + +BluetoothLe + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.auth.ble
+

Interface BluetoothLe

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + + + + + + + + + +
        +
      • +

        BLE_ERROR_DISABLED

        +
        static final int BLE_ERROR_DISABLED
        +
        The Bluetooth on the device is disabled
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_ERROR_NOT_SUPPORTED

        +
        static final int BLE_ERROR_NOT_SUPPORTED
        +
        The Bluetooth is not supported on the device
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_ERROR_INVALID_UUID

        +
        static final int BLE_ERROR_INVALID_UUID
        +
        The provided UUID is empty or invalid
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_ERROR_SESSION_SHARING_NOT_SUPPORTED

        +
        static final int BLE_ERROR_SESSION_SHARING_NOT_SUPPORTED
        +
        Bluetooth LE session sharing is not supported
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLeCentralCallback.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLeCentralCallback.html new file mode 100644 index 00000000..1114df87 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLeCentralCallback.html @@ -0,0 +1,431 @@ + + + + + +BluetoothLeCentralCallback + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.auth.ble
+

Interface BluetoothLeCentralCallback

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        BLE_STATE_SCAN_STARTED

        +
        static final int BLE_STATE_SCAN_STARTED
        +
        Bluetooth LE Scan has started
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_SCAN_STOPPED

        +
        static final int BLE_STATE_SCAN_STOPPED
        +
        Bluetooth LE scan has stopped
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_DEVICE_DETECTED

        +
        static final int BLE_STATE_DEVICE_DETECTED
        +
        Remote peripheral device has detected
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_CONNECTED

        +
        static final int BLE_STATE_CONNECTED
        +
        Connected to remote peripheral device
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_DISCONNECTED

        +
        static final int BLE_STATE_DISCONNECTED
        +
        Disconnected from remote peripheral device
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_SERVICE_DISCOVERED

        +
        static final int BLE_STATE_SERVICE_DISCOVERED
        +
        Bluetooth LE GATT Service has been discovered
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_CHARACTERISTIC_FOUND

        +
        static final int BLE_STATE_CHARACTERISTIC_FOUND
        +
        Bluetooth LE GATT Characteristic found
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_CHARACTERISTIC_WRITTEN

        +
        static final int BLE_STATE_CHARACTERISTIC_WRITTEN
        +
        Data has been written to Bluetooth GATT Characteristic
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_AUTH_SUCCEEDED

        +
        static final int BLE_STATE_AUTH_SUCCEEDED
        +
        The remote peripheral device has authorize the session sharing request
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_AUTH_FAILED

        +
        static final int BLE_STATE_AUTH_FAILED
        +
        The remote peripheral device has rejected or failed to authorize the session sharing request.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLeCentralRenderer.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLeCentralRenderer.html new file mode 100644 index 00000000..8fbfca6d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLeCentralRenderer.html @@ -0,0 +1,670 @@ + + + + + +BluetoothLeCentralRenderer + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth.ble
+

Class BluetoothLeCentralRenderer

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        MAX

        +
        public static final int MAX
        +
        Maximum bytes that can send with bluetooth characteristic
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        NOTIFY_UUID

        +
        private static final java.util.UUID NOTIFY_UUID
        +
        • +
      + + + +
        +
      • +

        bluetoothGatt

        +
        private android.bluetooth.BluetoothGatt bluetoothGatt
        +
        • +
      + + + +
        +
      • +

        scanner

        +
        private android.bluetooth.le.BluetoothLeScanner scanner
        +
        • +
      + + + +
        +
      • +

        scanCallback

        +
        private android.bluetooth.le.ScanCallback scanCallback
        +
        • +
      + + + +
        +
      • +

        serviceUUID

        +
        private java.util.UUID serviceUUID
        +
        • +
      + + + +
        +
      • +

        characteristicUUID

        +
        private java.util.UUID characteristicUUID
        +
        • +
      + + + + + + + +
        +
      • +

        rssi

        +
        private int rssi
        +
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        render

        +
        public android.view.View render()
        +
        Description copied from class: AuthRenderer
        +
        Render the view for the login, the view can be a image, button or null for no view. + The view will put to the login dialog as one of the login provider.
        +
        +
        Specified by:
        +
        render in class AuthRenderer
        +
        Returns:
        +
        The login view to represent the login action.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        onError

        +
        protected void onError(int code,
+                       java.lang.String message,
+                       java.lang.Exception e)
        +
        Notify the host application when any error occur.
        +
        +
        Specified by:
        +
        onError in class AuthRenderer
        +
        Parameters:
        +
        code - The status code corresponding to an BLE_ERROR* value defined under + BluetoothLeCentralCallback
        +
        message - Error message The error message
        +
        e - Exception The exception for the error.
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Description copied from class: AuthRenderer
        +
        Perform clean up for the renderer.
        +
        +
        Overrides:
        +
        close in class PollingRenderer
        +
        +
        • +
      + + + +
        +
      • +

        startScan

        +
        private void startScan()
        +
        • +
      + + + +
        +
      • +

        stopScan

        +
        private void stopScan()
        +
        • +
      + + + +
        +
      • +

        startProcess

        +
        private void startProcess(android.bluetooth.BluetoothDevice bluetoothDevice)
        +
        • +
      + + + +
        +
      • +

        onAuthCodeReceived

        +
        protected void onAuthCodeReceived(java.lang.String code,
+                                  java.lang.String state)
        +
        Description copied from class: AuthRenderer
        +
        Notify the Authenticate Renderer that Authorization code has been retrieved.
        +
        +
        Overrides:
        +
        onAuthCodeReceived in class PollingRenderer
        +
        Parameters:
        +
        code - Authorization Code
        +
        state - State from the response
        +
        +
        • +
      + + + +
        +
      • +

        splitArray

        +
        private java.util.List<byte[]> splitArray(byte[] items,
+                                          int max)
        +
        • +
      + + + + + + + +
        +
      • +

        getSessionRequest

        +
        private byte[] getSessionRequest()
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLeConsentHandler.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLeConsentHandler.html new file mode 100644 index 00000000..05b1e6e8 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLeConsentHandler.html @@ -0,0 +1,245 @@ + + + + + +BluetoothLeConsentHandler + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.auth.ble
+

Interface BluetoothLeConsentHandler

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidcancel() +
      Cancels the Session Sharing authorization request.
      +
      voidproceed() +
      Starts the Session Sharing authorization request.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        proceed

        +
        void proceed()
        +
        Starts the Session Sharing authorization request.
        +
        • +
      + + + +
        +
      • +

        cancel

        +
        void cancel()
        +
        Cancels the Session Sharing authorization request.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLePeripheral.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLePeripheral.html new file mode 100644 index 00000000..505d4e63 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLePeripheral.html @@ -0,0 +1,497 @@ + + + + + +BluetoothLePeripheral + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth.ble
+

Class BluetoothLePeripheral

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.auth.ble.BluetoothLePeripheral
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class BluetoothLePeripheral
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + + + + + + + + + +
        +
      • +

        appContext

        +
        private android.content.Context appContext
        +
        • +
      + + + + + + + +
        +
      • +

        advertiser

        +
        private android.bluetooth.le.BluetoothLeAdvertiser advertiser
        +
        • +
      + + + +
        +
      • +

        server

        +
        private android.bluetooth.BluetoothGattServer server
        +
        • +
      + + + +
        +
      • +

        connectedDevice

        +
        private android.bluetooth.BluetoothDevice connectedDevice
        +
        • +
      + + + +
        +
      • +

        isAuthenticating

        +
        private boolean isAuthenticating
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BluetoothLePeripheral

        +
        private BluetoothLePeripheral()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLePeripheralCallback.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLePeripheralCallback.html new file mode 100644 index 00000000..f182b2dd --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/BluetoothLePeripheralCallback.html @@ -0,0 +1,496 @@ + + + + + +BluetoothLePeripheralCallback + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.auth.ble
+

Interface BluetoothLePeripheralCallback

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        BLE_ERROR_ADVERTISE_FAILED

        +
        static final int BLE_ERROR_ADVERTISE_FAILED
        +
        Failed to advertise Bluetooth LE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_ERROR_AUTH_FAILED

        +
        static final int BLE_ERROR_AUTH_FAILED
        +
        Failed to authenticate the session
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_ERROR_PERIPHERAL_MODE_NOT_SUPPORTED

        +
        static final int BLE_ERROR_PERIPHERAL_MODE_NOT_SUPPORTED
        +
        Peripheral mode is not supported on the device
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_ERROR_CENTRAL_UNSUBSCRIBED

        +
        static final int BLE_ERROR_CENTRAL_UNSUBSCRIBED
        +
        Central device is not subscribed to receive the characteristic update.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_CONNECTED

        +
        static final int BLE_STATE_CONNECTED
        +
        Bluetooth LE Central device has been connected.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_DISCONNECTED

        +
        static final int BLE_STATE_DISCONNECTED
        +
        Bluetooth Central device has been disconnected.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_STARTED

        +
        static final int BLE_STATE_STARTED
        +
        The Bluetooth Peripheral Device is started and ready to accept session sharing request.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_STOPPED

        +
        static final int BLE_STATE_STOPPED
        +
        The Bluetooth Peripheral Device is stopped
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_SESSION_AUTHORIZED

        +
        static final int BLE_STATE_SESSION_AUTHORIZED
        +
        Session sharing authorization success
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BLE_STATE_SESSION_NOTIFIED

        +
        static final int BLE_STATE_SESSION_NOTIFIED
        +
        Session sharing has been notified to the central device
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onError

        +
        void onError(int errorCode)
        +
        Notify the host application that any error occur. + The error code corresponding to #BLE_ERROR* value.
        +
        • +
      + + + +
        +
      • +

        onConsentRequested

        +
        void onConsentRequested(java.lang.String deviceName,
+                        BluetoothLeConsentHandler handler)
        +
        Notify the host application that an consent request occurred while session + sharing. The host application must call either handler.cancel() or + handler.proceed().
        +
        +
        Parameters:
        +
        deviceName - The remote Bluetooth Device Name.
        +
        handler - An BluetoothLeConsentHandler object that will handle the user's + response.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/package-frame.html new file mode 100644 index 00000000..31a4e825 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/package-frame.html @@ -0,0 +1,28 @@ + + + + + +com.ca.mas.core.auth.ble + + + + + +

com.ca.mas.core.auth.ble

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/package-summary.html new file mode 100644 index 00000000..2efbce12 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/package-summary.html @@ -0,0 +1,175 @@ + + + + + +com.ca.mas.core.auth.ble + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.auth.ble

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/package-tree.html new file mode 100644 index 00000000..b683fbc7 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/ble/package-tree.html @@ -0,0 +1,154 @@ + + + + + +com.ca.mas.core.auth.ble Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.auth.ble

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/OtpAuthenticationHandler.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/OtpAuthenticationHandler.html new file mode 100644 index 00000000..96f7452a --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/OtpAuthenticationHandler.html @@ -0,0 +1,465 @@ + + + + + +OtpAuthenticationHandler + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth.otp
+

Class OtpAuthenticationHandler

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.auth.otp.OtpAuthenticationHandler
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.os.Parcelable
    +
    +
    +
    +
    public class OtpAuthenticationHandler
+extends java.lang.Object
+implements android.os.Parcelable
    +
    Handler class for the OTP flow.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface android.os.Parcelable

        +android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static android.os.Parcelable.Creator<OtpAuthenticationHandler>CREATOR 
      +
        +
      • + + +

        Fields inherited from interface android.os.Parcelable

        +CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
       OtpAuthenticationHandler(long requestId, + java.util.List<java.lang.String> channels, + boolean isInvalidOtp, + java.lang.String selectedChannels) 
      protected OtpAuthenticationHandler(android.os.Parcel in) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidcancel() +
      Cancel the fetch otp protected data request.
      +
      voiddeliver(java.lang.String channels, + MAGResultReceiver<java.lang.Void> callback) +
      Proceed to invoke server to deliver the OTP to the given delivery channel.
      +
      intdescribeContents() 
      java.util.List<java.lang.String>getChannels() 
      booleanisInvalidOtp() 
      voidproceed(android.content.Context context, + java.lang.String otp) +
      Proceed to invoke server to validate the OTP.
      +
      voidwriteToParcel(android.os.Parcel dest, + int flags) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        OtpAuthenticationHandler

        +
        public OtpAuthenticationHandler(long requestId,
+                                java.util.List<java.lang.String> channels,
+                                boolean isInvalidOtp,
+                                java.lang.String selectedChannels)
        +
        • +
      + + + +
        +
      • +

        OtpAuthenticationHandler

        +
        protected OtpAuthenticationHandler(android.os.Parcel in)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        proceed

        +
        public void proceed(android.content.Context context,
+                    java.lang.String otp)
        +
        Proceed to invoke server to validate the OTP.
        +
        +
        Parameters:
        +
        context - Application context
        +
        otp - the OTP to be validated
        +
        +
        • +
      + + + +
        +
      • +

        deliver

        +
        public void deliver(java.lang.String channels,
+                    MAGResultReceiver<java.lang.Void> callback)
        +
        Proceed to invoke server to deliver the OTP to the given delivery channel.
        +
        +
        Parameters:
        +
        channels - the name of the delivery channel
        +
        callback - the callback for delivering a success or error
        +
        +
        • +
      + + + +
        +
      • +

        getChannels

        +
        public java.util.List<java.lang.String> getChannels()
        +
        • +
      + + + +
        +
      • +

        isInvalidOtp

        +
        public boolean isInvalidOtp()
        +
        • +
      + + + +
        +
      • +

        cancel

        +
        public void cancel()
        +
        Cancel the fetch otp protected data request.
        +
        • +
      + + + +
        +
      • +

        describeContents

        +
        public int describeContents()
        +
        +
        Specified by:
        +
        describeContents in interface android.os.Parcelable
        +
        +
        • +
      + + + +
        +
      • +

        writeToParcel

        +
        public void writeToParcel(android.os.Parcel dest,
+                          int flags)
        +
        +
        Specified by:
        +
        writeToParcel in interface android.os.Parcelable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/OtpConstants.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/OtpConstants.html new file mode 100644 index 00000000..f99ba3f6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/OtpConstants.html @@ -0,0 +1,381 @@ + + + + + +OtpConstants + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth.otp
+

Class OtpConstants

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.auth.otp.OtpConstants
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class OtpConstants
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      OtpConstants() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        ACTION_DISPLAY_OTP_PROTECTED_DATA

        +
        public static final java.lang.String ACTION_DISPLAY_OTP_PROTECTED_DATA
        +
        An Intent with this action is used to start a OTP dialog activity when OTP is needed. + Handled by OTP activity.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + +
        +
      • +

        X_OTP_CHANNEL

        +
        public static final java.lang.String X_OTP_CHANNEL
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        X_OTP_RETRY

        +
        public static final java.lang.String X_OTP_RETRY
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        X_OTP_RETRY_INTERVAL

        +
        public static final java.lang.String X_OTP_RETRY_INTERVAL
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + +
        +
      • +

        IS_INVALID_OTP

        +
        public static final java.lang.String IS_INVALID_OTP
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OtpConstants

        +
        public OtpConstants()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/OtpUtil.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/OtpUtil.html new file mode 100644 index 00000000..1cfb3864 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/OtpUtil.html @@ -0,0 +1,310 @@ + + + + + +OtpUtil + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.auth.otp
+

Class OtpUtil

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.auth.otp.OtpUtil
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class OtpUtil
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OtpUtil

        +
        private OtpUtil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getXotpValueFromHeaders

        +
        public static OtpResponseHeaders getXotpValueFromHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        parseOtpResponseBody

        +
        public static OtpResponseBody parseOtpResponseBody(java.lang.String body)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASMultiFactorHandler.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/OtpResponseBody.html similarity index 59% rename from source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASMultiFactorHandler.html rename to source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/OtpResponseBody.html index c87c7cd5..d01edef0 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASMultiFactorHandler.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/OtpResponseBody.html @@ -2,23 +2,23 @@ - -MASMultiFactorHandler (mas-foundation API) - - - + +OtpResponseBody + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth.otp.model
+

Enum OtpResponseHeaders.X_CA_ERROR

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static OtpResponseHeaders.X_CA_ERROR[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (OtpResponseHeaders.X_CA_ERROR c : OtpResponseHeaders.X_CA_ERROR.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static OtpResponseHeaders.X_CA_ERROR valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/OtpResponseHeaders.X_OTP_VALUE.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/OtpResponseHeaders.X_OTP_VALUE.html new file mode 100644 index 00000000..0f72ed9e --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/OtpResponseHeaders.X_OTP_VALUE.html @@ -0,0 +1,403 @@ + + + + + +OtpResponseHeaders.X_OTP_VALUE + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth.otp.model
+

Enum OtpResponseHeaders.X_OTP_VALUE

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static OtpResponseHeaders.X_OTP_VALUEvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static OtpResponseHeaders.X_OTP_VALUE[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static OtpResponseHeaders.X_OTP_VALUE[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (OtpResponseHeaders.X_OTP_VALUE c : OtpResponseHeaders.X_OTP_VALUE.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static OtpResponseHeaders.X_OTP_VALUE valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/OtpResponseHeaders.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/OtpResponseHeaders.html new file mode 100644 index 00000000..0bd2e443 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/OtpResponseHeaders.html @@ -0,0 +1,620 @@ + + + + + +OtpResponseHeaders + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.auth.otp.model
+

Class OtpResponseHeaders

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.auth.otp.model.OtpResponseHeaders
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.os.Parcelable
    +
    +
    +
    +
    public class OtpResponseHeaders
+extends java.lang.Object
+implements android.os.Parcelable
    +
    A model object to store the parsed OTP MAG Gateway response headers data
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OtpResponseHeaders

        +
        public OtpResponseHeaders()
        +
        • +
      + + + +
        +
      • +

        OtpResponseHeaders

        +
        protected OtpResponseHeaders(android.os.Parcel in)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getRetry

        +
        public int getRetry()
        +
        • +
      + + + +
        +
      • +

        setRetry

        +
        public void setRetry(int retry)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getRetryInterval

        +
        public int getRetryInterval()
        +
        • +
      + + + +
        +
      • +

        setRetryInterval

        +
        public void setRetryInterval(int retryInterval)
        +
        • +
      + + + +
        +
      • +

        setChannels

        +
        public void setChannels(java.util.List<java.lang.String> channels)
        +
        • +
      + + + +
        +
      • +

        getChannels

        +
        public java.util.List<java.lang.String> getChannels()
        +
        • +
      + + + +
        +
      • +

        writeToParcel

        +
        public void writeToParcel(android.os.Parcel dest,
+                          int flags)
        +
        +
        Specified by:
        +
        writeToParcel in interface android.os.Parcelable
        +
        +
        • +
      + + + +
        +
      • +

        describeContents

        +
        public int describeContents()
        +
        +
        Specified by:
        +
        describeContents in interface android.os.Parcelable
        +
        +
        • +
      + + + +
        +
      • +

        getHttpStatusCode

        +
        public int getHttpStatusCode()
        +
        • +
      + + + +
        +
      • +

        setHttpStatusCode

        +
        public void setHttpStatusCode(int httpStatusCode)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/package-frame.html new file mode 100644 index 00000000..31982e93 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/package-frame.html @@ -0,0 +1,26 @@ + + + + + +com.ca.mas.core.auth.otp.model + + + + + +

com.ca.mas.core.auth.otp.model

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/package-summary.html new file mode 100644 index 00000000..7135afff --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/package-summary.html @@ -0,0 +1,167 @@ + + + + + +com.ca.mas.core.auth.otp.model + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.auth.otp.model

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/package-tree.html new file mode 100644 index 00000000..08a92828 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/model/package-tree.html @@ -0,0 +1,149 @@ + + + + + +com.ca.mas.core.auth.otp.model Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.auth.otp.model

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • com.ca.mas.core.auth.otp.model.OtpResponseBody (implements android.os.Parcelable)
      • +
    • com.ca.mas.core.auth.otp.model.OtpResponseHeaders (implements android.os.Parcelable)
      • +
    +
    • +
+

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/package-frame.html new file mode 100644 index 00000000..99d3d279 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.ca.mas.core.auth.otp + + + + + +

com.ca.mas.core.auth.otp

+
+

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/package-summary.html new file mode 100644 index 00000000..dc12b5ed --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/package-summary.html @@ -0,0 +1,144 @@ + + + + + +com.ca.mas.core.auth.otp + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.auth.otp

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/package-tree.html new file mode 100644 index 00000000..6b1f99a6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/otp/package-tree.html @@ -0,0 +1,136 @@ + + + + + +com.ca.mas.core.auth.otp Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.auth.otp

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/package-frame.html new file mode 100644 index 00000000..80422977 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/package-frame.html @@ -0,0 +1,33 @@ + + + + + +com.ca.mas.core.auth + + + + + +

com.ca.mas.core.auth

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/package-summary.html new file mode 100644 index 00000000..a2fff5aa --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/package-summary.html @@ -0,0 +1,204 @@ + + + + + +com.ca.mas.core.auth + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.auth

+
+
+
    +
  • + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    AuthResultReceiver +
    Abstract interface for cross device result receiver.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    AuthRenderer 
    NFCRenderer +
    NFC for cross device session sharing
    +
    NfcResultReceiver +
    The default NFC result receiver.
    +
    PollingRenderer +
    Poll MAG periodically for the Authorization Code
    +
    QRCode +
    A QRCode ImageView
    +
    QRCodeRenderer +
    Render the QRCode for cross device session sharing
    +
    +
    • +
  • + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    AuthenticationException +
    This exception is thrown when an authentication error occurs while accessing the MAG Server register or token endpoint.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/package-tree.html new file mode 100644 index 00000000..7ca9c784 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/auth/package-tree.html @@ -0,0 +1,184 @@ + + + + + +com.ca.mas.core.auth Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.auth

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/CertUtils.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/CertUtils.html new file mode 100644 index 00000000..704ed7ed --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/CertUtils.html @@ -0,0 +1,456 @@ + + + + + +CertUtils + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.cert
+

Class CertUtils

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.cert.CertUtils
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class CertUtils
+extends java.lang.Object
    +
    Utility methods for working with certificate and CSRs.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private CertUtils() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.security.cert.X509CertificatedecodeCertFromPem(java.lang.String certificateText) +
      Decode an X.509 certificate that is encoded as Base-64, with or without PEM "BEGIN CERTIFICATE" markers.
      +
      static java.security.cert.X509Certificate[]decodeCertificateChain(byte[] chainBytes) +
      Decode a certificate chain into a an array of X509Certificate instances.
      +
      static byte[]encodeCertificateChain(java.security.cert.X509Certificate[] chain) +
      Encode a certificate chain to a byte array.
      +
      static byte[]generateCertificateSigningRequest(java.lang.String commonName, + java.lang.String deviceId, + java.lang.String deviceName, + java.lang.String organization, + java.security.PublicKey publicKey, + java.security.PrivateKey privateKey) +
      Generate a PKCS#10 certificate signing request from the specified parameters.
      +
      private static java.security.cert.X509Certificate[]toX509CertArray(java.util.Collection<? extends java.security.cert.Certificate> certs) +
      Convert the specified Certificate array into an X509Certificate array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        PEM_CERT_BEGIN_MARKER

        +
        private static final java.lang.String PEM_CERT_BEGIN_MARKER
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PEM_CERT_END_MARKER

        +
        private static final java.lang.String PEM_CERT_END_MARKER
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CertUtils

        +
        private CertUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        decodeCertFromPem

        +
        public static java.security.cert.X509Certificate decodeCertFromPem(java.lang.String certificateText)
+                                                            throws java.io.IOException
        +
        Decode an X.509 certificate that is encoded as Base-64, with or without PEM "BEGIN CERTIFICATE" markers.
        +
        +
        Parameters:
        +
        certificateText - the certificate in PEM format, optionally with begin and end markers.
        +
        Returns:
        +
        an X509Certificate instance produced with the default X.509 CertificateFactory.
        +
        Throws:
        +
        java.io.IOException - if PEM or Base-64 decoding fails.
        +
        +
        • +
      + + + +
        +
      • +

        generateCertificateSigningRequest

        +
        public static byte[] generateCertificateSigningRequest(java.lang.String commonName,
+                                                       java.lang.String deviceId,
+                                                       java.lang.String deviceName,
+                                                       java.lang.String organization,
+                                                       java.security.PublicKey publicKey,
+                                                       java.security.PrivateKey privateKey)
+                                                throws java.security.cert.CertificateException
        +
        Generate a PKCS#10 certificate signing request from the specified parameters.
        +
        +
        Parameters:
        +
        commonName - the username. Required.
        +
        deviceId - the device ID. Required.
        +
        deviceName - the device name. Required.
        +
        organization - the organization. Required.
        +
        publicKey - the client's public key. Required.
        +
        privateKey - the client's private key. Required.
        +
        Returns:
        +
        a signed PKCS#10 CertificationRequest structure in binary DER format. Never null.
        +
        Throws:
        +
        java.security.cert.CertificateException - if a CSR cannot be created
        +
        +
        • +
      + + + +
        +
      • +

        toX509CertArray

        +
        private static java.security.cert.X509Certificate[] toX509CertArray(java.util.Collection<? extends java.security.cert.Certificate> certs)
        +
        Convert the specified Certificate array into an X509Certificate array.
        +
        +
        Parameters:
        +
        certs - certificate array to convert. Required.
        +
        Returns:
        +
        a same-length array of type X509Certificate[].
        +
        Throws:
        +
        java.lang.ClassCastException - if at least one certificate is not an X509Certificate.
        +
        +
        • +
      + + + +
        +
      • +

        decodeCertificateChain

        +
        public static java.security.cert.X509Certificate[] decodeCertificateChain(byte[] chainBytes)
        +
        Decode a certificate chain into a an array of X509Certificate instances.
        +
        +
        Parameters:
        +
        chainBytes - the certificate chain bytes. Required.
        +
        Returns:
        +
        an array of X509Certificate instances.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the chain cannot be decoded
        +
        +
        • +
      + + + +
        +
      • +

        encodeCertificateChain

        +
        public static byte[] encodeCertificateChain(java.security.cert.X509Certificate[] chain)
        +
        Encode a certificate chain to a byte array. +

        + The returned byte array is simply the encoded form of each certificate appended to the array + one by one without any surrounding structure or other delimiters, with the subject cert coming first.

        +
        +
        Parameters:
        +
        chain - the chain to encode. Required.
        +
        Returns:
        +
        the encoded bytes of the chain.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the chain cannot be encoded.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/PublicKeyHash.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/PublicKeyHash.html new file mode 100644 index 00000000..a23fbf69 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/PublicKeyHash.html @@ -0,0 +1,538 @@ + + + + + +PublicKeyHash + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.cert
+

Class PublicKeyHash

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.cert.PublicKeyHash
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PublicKeyHash
+extends java.lang.Object
+implements java.io.Serializable
    +
    Represents an SHA-256 fingerprint of a public key from a trusted CA cert. This is used to prevent man-in-the-middle + attacks by a compromised/hostile/government-compelled CA by way of checking whether the trust anchor's public key + is from a recognized list. +

    + To create an instance of this class use the fromPublicKey(java.security.PublicKey) or fromHashString(String, int) method.

    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private byte[]hash 
      private static java.util.regex.PatternSHA256_HEX_PATTERN 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private PublicKeyHash(byte[] hash) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object o) 
      static PublicKeyHashfromCertificate(java.security.cert.Certificate certificate) +
      Create a new key hash from the specified public key.
      +
      static PublicKeyHashfromHashString(java.lang.String hashString, + int flags) +
      Create a new key hash from the specified hash string.
      +
      static PublicKeyHashfromPublicKey(java.security.PublicKey publicKey) +
      Create a new key hash from the specified public key.
      +
      java.lang.StringgetHashString() 
      inthashCode() 
      booleanmatches(byte[] otherHash) +
      Check if this key hash matches the specified key hash.
      +
      booleanmatches(java.security.PublicKey publicKey) +
      Check if this key hash matches that of the specified public key.
      +
      booleanmatches(java.security.cert.X509Certificate certificate) +
      Check if this key hash matches that of the public key in the specified certificate.
      +
      private static byte[]toHash(java.security.PublicKey publicKey) +
      Get the key hash for the specified public key.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        SHA256_HEX_PATTERN

        +
        private static final java.util.regex.Pattern SHA256_HEX_PATTERN
        +
        • +
      + + + +
        +
      • +

        hash

        +
        private final byte[] hash
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PublicKeyHash

        +
        private PublicKeyHash(byte[] hash)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fromPublicKey

        +
        public static PublicKeyHash fromPublicKey(java.security.PublicKey publicKey)
        +
        Create a new key hash from the specified public key.
        +
        +
        Parameters:
        +
        publicKey - the public key to examine. Required.
        +
        Returns:
        +
        a new key hash. Never null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the public key's encoding format is not "X.509".
        +
        +
        • +
      + + + +
        +
      • +

        fromCertificate

        +
        public static PublicKeyHash fromCertificate(java.security.cert.Certificate certificate)
        +
        Create a new key hash from the specified public key.
        +
        +
        Parameters:
        +
        certificate - the certificate whose key hash to compute. Required.
        +
        Returns:
        +
        a new key hash. Never null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the public key's encoding format is not "X.509".
        +
        +
        • +
      + + + +
        +
      • +

        fromHashString

        +
        public static PublicKeyHash fromHashString(java.lang.String hashString,
+                                           int flags)
        +
        Create a new key hash from the specified hash string.
        +
        +
        Parameters:
        +
        hashString - the base64 hash string.
        +
        flags - controls certain features of the decoded output. + Pass Base64.DEFAULT to decode standard Base64.
        +
        Returns:
        +
        a new key hash. Never null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the hash string is not in the expected format.
        +
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public boolean matches(byte[] otherHash)
        +
        Check if this key hash matches the specified key hash.
        +
        +
        Parameters:
        +
        otherHash - the other key hash, as a lowercase hex dump of an SHA-256 hash of the SubjectPublicKeyInfo structure.
        +
        Returns:
        +
        true if this hash matches the other hash.
        +
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public boolean matches(java.security.PublicKey publicKey)
        +
        Check if this key hash matches that of the specified public key.
        +
        +
        Parameters:
        +
        publicKey - the public key to compare against. Required.
        +
        Returns:
        +
        true if this hash matches that key's hash.
        +
        +
        • +
      + + + +
        +
      • +

        matches

        +
        public boolean matches(java.security.cert.X509Certificate certificate)
        +
        Check if this key hash matches that of the public key in the specified certificate.
        +
        +
        Parameters:
        +
        certificate - the certificate whose public key to compare against. Required.
        +
        Returns:
        +
        true if this hash matches that certificate's public key's hash.
        +
        +
        • +
      + + + +
        +
      • +

        getHashString

        +
        public java.lang.String getHashString()
        +
        +
        Returns:
        +
        the key hash as an SHA-256 Base64 string.
        +
        +
        • +
      + + + +
        +
      • +

        toHash

        +
        private static byte[] toHash(java.security.PublicKey publicKey)
        +
        Get the key hash for the specified public key.
        +
        +
        Parameters:
        +
        publicKey - a public key. Required.
        +
        Returns:
        +
        a key hash
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the public key's encoding format is not "X.509".
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/TrustedCertificateConfiguration.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/TrustedCertificateConfiguration.html new file mode 100644 index 00000000..b581c8d4 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/TrustedCertificateConfiguration.html @@ -0,0 +1,292 @@ + + + + + +TrustedCertificateConfiguration + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.cert
+

Interface TrustedCertificateConfiguration

+
+
+
+
    +
  • +
    +
    All Known Subinterfaces:
    +
    ConfigurationProvider
    +
    +
    +
    All Known Implementing Classes:
    +
    DefaultConfiguration
    +
    +
    +
    +
    public interface TrustedCertificateConfiguration
    +
    Interface that describes trusted TLS server certs (including self-signed certs and public PKI, with or without + public key pinning).
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTrustedCertificateAnchors

        +
        java.util.Collection<java.security.cert.X509Certificate> getTrustedCertificateAnchors()
        +
        Get the server certificate trust anchors that should be trusted for outbound TLS. +

        + If isAlsoTrustPublicPki() returns false, then only TLS server certs on this list + (or directly or indirectly signed by certs on this list) will be trusted for outbound TLS.

        +
        +
        Returns:
        +
        a collection of certificates trusted as
        +
        +
        • +
      + + + +
        +
      • +

        isAlsoTrustPublicPki

        +
        boolean isAlsoTrustPublicPki()
        +
        Check whether public CAs recognized by the OS should be accepted as TLS server certs in addition + to the list returned by getTrustedCertificateAnchors().
        +
        +
        Returns:
        +
        true if public CAs known to the OS should be trusted for outbound TLS. + false if only the certs returned by getTrustedCertificateAnchors() should be trusted.
        +
        +
        • +
      + + + +
        +
      • +

        getTrustedCertificatePinnedPublicKeyHashes

        +
        java.util.Collection<PublicKeyHash> getTrustedCertificatePinnedPublicKeyHashes()
        +
        Get server certificate pinned public keys. +

        + This is only really useful if isAlsoTrustPublicPki() returns true. If you don't trust public + PKI certs and are relying on internal PKI or self-signed certificates built into the app then you probably + do not need to worry about certificate pinning. +

        + If this list is nonempty then a TLS server cert will be accepted only if one of the pinned public keys + appears somewhere in its certificate chain. +

        + This prevents CAs -- any public CA, not necessarily the CA that signed the server cert originally -- from being + able to create a forged server certificate for an arbitrary target domain.

        +
        +
        Returns:
        +
        a list of pinned server certificate public keys, or empty (or null) if pinning should not be used.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/package-frame.html new file mode 100644 index 00000000..7e430f73 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/package-frame.html @@ -0,0 +1,25 @@ + + + + + +com.ca.mas.core.cert + + + + + +

com.ca.mas.core.cert

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/package-summary.html new file mode 100644 index 00000000..684c4f1d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/package-summary.html @@ -0,0 +1,166 @@ + + + + + +com.ca.mas.core.cert + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.cert

+
+
+
    +
  • + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    TrustedCertificateConfiguration +
    Interface that describes trusted TLS server certs (including self-signed certs and public PKI, with or without + public key pinning).
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    CertUtils +
    Utility methods for working with certificate and CSRs.
    +
    PublicKeyHash +
    Represents an SHA-256 fingerprint of a public key from a trusted CA cert.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/package-tree.html new file mode 100644 index 00000000..fcb29abc --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/cert/package-tree.html @@ -0,0 +1,140 @@ + + + + + +com.ca.mas.core.cert Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.cert

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/ServerClient.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/ServerClient.html new file mode 100644 index 00000000..b5fb5b22 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/ServerClient.html @@ -0,0 +1,908 @@ + + + + + +ServerClient + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.client
+

Class ServerClient

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.client.ServerClient
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ClientCredentialsClient, OAuthClient, OAuthTokenClient, RegistrationClient
    +
    +
    +
    +
    public abstract class ServerClient
+extends java.lang.Object
    +
    Utility class that encapsulates talking to the token server into Java method calls. + This handles just the network protocol for communicating with the token server to register a device, obtain an access token, etc. + It does not deal with state management, token persistence, looking up credentials in the context, or anything other + higher-level issue.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/ServerResponse.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/ServerResponse.html new file mode 100644 index 00000000..9f9ea45f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/ServerResponse.html @@ -0,0 +1,442 @@ + + + + + +ServerResponse + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.client
+

Class ServerResponse

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.client.ServerResponse
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    OAuthTokenResponse
    +
    +
    +
    +
    public class ServerResponse
+extends java.lang.Object
    +
    Represents a JSON response from the token server. +

    + This is either a JSON success or error response from the request_token or request_token_sso method, + or a JSON error response from the register_device method.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected interrorCode 
      protected java.lang.Stringjson 
      protected org.json.JSONObjectparsed 
      protected intstatus 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ServerResponse(int status, + int errorCode, + java.lang.String json) +
      Create a JSON response from the specified HTTP status code and JSON string.
      +
      ServerResponse(int status, + java.lang.String json) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetErrorCode() 
      java.lang.StringgetJson() 
      intgetStatus() 
      booleanisError() +
      Check for an error field in the JSON response.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        status

        +
        protected int status
        +
        • +
      + + + +
        +
      • +

        errorCode

        +
        protected int errorCode
        +
        • +
      + + + +
        +
      • +

        json

        +
        protected final java.lang.String json
        +
        • +
      + + + +
        +
      • +

        parsed

        +
        protected final org.json.JSONObject parsed
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ServerResponse

        +
        public ServerResponse(int status,
+                      java.lang.String json)
+               throws org.json.JSONException
        +
        +
        Throws:
        +
        org.json.JSONException
        +
        +
        • +
      + + + +
        +
      • +

        ServerResponse

        +
        public ServerResponse(int status,
+                      int errorCode,
+                      java.lang.String json)
+               throws org.json.JSONException
        +
        Create a JSON response from the specified HTTP status code and JSON string.
        +
        +
        Parameters:
        +
        status - HTTP status code, eg 401.
        +
        errorCode - Header x-ca-err code
        +
        json - string respresenting a single JSON object, eg 
        { "error":"invalid_request", "error_description":"Validation error" }
        +
        Throws:
        +
        org.json.JSONException - if the JSON string cannot be parsed as a JSON object
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStatus

        +
        public int getStatus()
        +
        +
        Returns:
        +
        the HTTP status.
        +
        +
        • +
      + + + +
        +
      • +

        getJson

        +
        public java.lang.String getJson()
        +
        +
        Returns:
        +
        the raw JSON string.
        +
        +
        • +
      + + + +
        +
      • +

        isError

        +
        public boolean isError()
        +
        Check for an error field in the JSON response. + Note: you should probably also check for a non-2xx getStatus() value.
        +
        +
        Returns:
        +
        true if the JSON object includes a string field named "error".
        +
        +
        • +
      + + + +
        +
      • +

        getErrorCode

        +
        public int getErrorCode()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/package-frame.html new file mode 100644 index 00000000..b7000cc6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.ca.mas.core.client + + + + + +

com.ca.mas.core.client

+
+

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/package-summary.html new file mode 100644 index 00000000..baf82367 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/package-summary.html @@ -0,0 +1,148 @@ + + + + + +com.ca.mas.core.client + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.client

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    ServerClient +
    Utility class that encapsulates talking to the token server into Java method calls.
    +
    ServerResponse +
    Represents a JSON response from the token server.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/package-tree.html new file mode 100644 index 00000000..fc5dbe55 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/client/package-tree.html @@ -0,0 +1,136 @@ + + + + + +com.ca.mas.core.client Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.client

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/ClientCredentialsClient.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/ClientCredentialsClient.html new file mode 100644 index 00000000..a03f75d6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/ClientCredentialsClient.html @@ -0,0 +1,313 @@ + + + + + +ClientCredentialsClient + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.clientcredentials
+

Class ClientCredentialsClient

+
+
+ +
+
    +
  • +
    +
    +
    public class ClientCredentialsClient
+extends ServerClient
    +
    Utility class that encapsulates talking to the token server into Java method calls. + This handles just the network protocol for communicating with the MAG server to obtain dynamic client id and client credentials + It does not deal with state management, token persistence, looking up credentials in the context, or anything other + higher-level issue.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/ClientCredentialsException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/ClientCredentialsException.html new file mode 100644 index 00000000..a804e2df --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/ClientCredentialsException.html @@ -0,0 +1,317 @@ + + + + + +ClientCredentialsException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.clientcredentials
+

Class ClientCredentialsException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class ClientCredentialsException
+extends MAGException
    +
    This exception is thrown when an error occurs while initializing the dynamic client id and client credentials.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ClientCredentialsException

        +
        public ClientCredentialsException(int errorCode)
        +
        • +
      + + + +
        +
      • +

        ClientCredentialsException

        +
        public ClientCredentialsException(int errorCode,
+                                  java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        ClientCredentialsException

        +
        public ClientCredentialsException(int errorCode,
+                                  java.lang.String detailMessage,
+                                  java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        ClientCredentialsException

        +
        public ClientCredentialsException(int errorCode,
+                                  java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/ClientCredentialsServerException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/ClientCredentialsServerException.html new file mode 100644 index 00000000..dfc64b49 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/ClientCredentialsServerException.html @@ -0,0 +1,315 @@ + + + + + +ClientCredentialsServerException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.clientcredentials
+

Class ClientCredentialsServerException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class ClientCredentialsServerException
+extends MAGServerException
    +
    This exception is thrown when an error occurs while accessing the MAG Server initialize endpoint
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ClientCredentialsServerException

        +
        public ClientCredentialsServerException(MASResponse response,
+                                        int errorCode,
+                                        int status,
+                                        java.lang.String contentType,
+                                        java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        ClientCredentialsServerException

        +
        public ClientCredentialsServerException(MASResponse response,
+                                        int errorCode,
+                                        int status,
+                                        java.lang.String contentType,
+                                        java.lang.String detailMessage,
+                                        java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        ClientCredentialsServerException

        +
        public ClientCredentialsServerException(MAGServerException e)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/package-frame.html new file mode 100644 index 00000000..09f6d81a --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/package-frame.html @@ -0,0 +1,25 @@ + + + + + +com.ca.mas.core.clientcredentials + + + + + +

com.ca.mas.core.clientcredentials

+
+

Classes

+ +

Exceptions

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/package-summary.html new file mode 100644 index 00000000..b2a762fe --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/package-summary.html @@ -0,0 +1,165 @@ + + + + + +com.ca.mas.core.clientcredentials + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.clientcredentials

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    ClientCredentialsClient +
    Utility class that encapsulates talking to the token server into Java method calls.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    ClientCredentialsException +
    This exception is thrown when an error occurs while initializing the dynamic client id and client credentials.
    +
    ClientCredentialsServerException +
    This exception is thrown when an error occurs while accessing the MAG Server initialize endpoint
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/package-tree.html new file mode 100644 index 00000000..eb818bc1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/clientcredentials/package-tree.html @@ -0,0 +1,157 @@ + + + + + +com.ca.mas.core.clientcredentials Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.clientcredentials

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/Config.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/Config.html new file mode 100644 index 00000000..32929a46 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/Config.html @@ -0,0 +1,742 @@ + + + + + +Config + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.conf
+

Class Config

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.conf.Config
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class Config
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        HOSTNAME

        +
        public static final Config HOSTNAME
        +
        • +
      + + + +
        +
      • +

        PORT

        +
        public static final Config PORT
        +
        • +
      + + + +
        +
      • +

        PREFIX

        +
        public static final Config PREFIX
        +
        • +
      + + + +
        +
      • +

        SERVER_CERTS

        +
        public static final Config SERVER_CERTS
        +
        • +
      + + + +
        +
      • +

        ORGANIZATION

        +
        public static final Config ORGANIZATION
        +
        • +
      + + + +
        +
      • +

        CLIENT_KEY

        +
        public static final Config CLIENT_KEY
        +
        • +
      + + + +
        +
      • +

        CLIENT_SECRET

        +
        public static final Config CLIENT_SECRET
        +
        • +
      + + + +
        +
      • +

        SCOPE

        +
        public static final Config SCOPE
        +
        • +
      + + + +
        +
      • +

        REDIRECT_URI

        +
        public static final Config REDIRECT_URI
        +
        • +
      + + + +
        +
      • +

        AUTHORIZE_PATH

        +
        public static final Config AUTHORIZE_PATH
        +
        • +
      + + + +
        +
      • +

        REGISTER_TOKEN_PATH

        +
        public static final Config REGISTER_TOKEN_PATH
        +
        • +
      + + + +
        +
      • +

        REGISTER_TOKEN_PATH_SSO

        +
        public static final Config REGISTER_TOKEN_PATH_SSO
        +
        • +
      + + + +
        +
      • +

        LOGOUT_DEVICE_PATH

        +
        public static final Config LOGOUT_DEVICE_PATH
        +
        • +
      + + + +
        +
      • +

        REMOVE_DEVICE_PATH

        +
        public static final Config REMOVE_DEVICE_PATH
        +
        • +
      + + + +
        +
      • +

        REGISTER_DEVICE_PATH

        +
        public static final Config REGISTER_DEVICE_PATH
        +
        • +
      + + + +
        +
      • +

        RENEW_DEVICE_PATH

        +
        public static final Config RENEW_DEVICE_PATH
        +
        • +
      + + + +
        +
      • +

        REGISTER_DEVICE_PATH_CLIENT

        +
        public static final Config REGISTER_DEVICE_PATH_CLIENT
        +
        • +
      + + + +
        +
      • +

        CLIENT_CREDENTIAL_INIT_PATH

        +
        public static final Config CLIENT_CREDENTIAL_INIT_PATH
        +
        • +
      + + + +
        +
      • +

        AUTHENTICATE_OTP_PATH

        +
        public static final Config AUTHENTICATE_OTP_PATH
        +
        • +
      + + + +
        +
      • +

        ENTERPRISE_APP_PATH

        +
        public static final Config ENTERPRISE_APP_PATH
        +
        • +
      + + + +
        +
      • +

        SSO_ENABLED

        +
        public static final Config SSO_ENABLED
        +
        • +
      + + + +
        +
      • +

        LOCATION_ENABLED

        +
        public static final Config LOCATION_ENABLED
        +
        • +
      + + + +
        +
      • +

        LOCATION_PROVIDER

        +
        public static final Config LOCATION_PROVIDER
        +
        • +
      + + + +
        +
      • +

        MSISDN_ENABLED

        +
        public static final Config MSISDN_ENABLED
        +
        • +
      + + + +
        +
      • +

        TRUSTED_PUBLIC_PKI

        +
        public static final Config TRUSTED_PUBLIC_PKI
        +
        • +
      + + + +
        +
      • +

        TRUSTED_CERT_PINNED_PUBLIC_KEY_HASHES

        +
        public static final Config TRUSTED_CERT_PINNED_PUBLIC_KEY_HASHES
        +
        • +
      + + + +
        +
      • +

        CLIENT_CERT_RSA_KEYBITS

        +
        public static final Config CLIENT_CERT_RSA_KEYBITS
        +
        • +
      + + + +
        +
      • +

        CLIENT_STORAGE

        +
        public static final Config CLIENT_STORAGE
        +
        • +
      + + + +
        +
      • +

        BLE_SERVICE_UUID

        +
        public static final Config BLE_SERVICE_UUID
        +
        • +
      + + + +
        +
      • +

        BLE_USER_SESSION_CHARACTERISTIC_UUID

        +
        public static final Config BLE_USER_SESSION_CHARACTERISTIC_UUID
        +
        • +
      + + + +
        +
      • +

        BLE_RSSI

        +
        public static final Config BLE_RSSI
        +
        • +
      + + + +
        +
      • +

        values

        +
        public static Config[] values
        +
        • +
      + + + +
        +
      • +

        mandatory

        +
        public boolean mandatory
        +
        • +
      + + + +
        +
      • +

        key

        +
        public java.lang.String key
        +
        • +
      + + + +
        +
      • +

        path

        +
        public java.lang.String path
        +
        • +
      + + + +
        +
      • +

        type

        +
        public java.lang.Class type
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Config

        +
        public Config(boolean mandatory,
+              java.lang.String key,
+              java.lang.String path,
+              java.lang.Class type)
        +
        SDK Configuration
        +
        +
        Parameters:
        +
        mandatory -
        +
        key - The Bundle Key
        +
        path - The path which may to the JSON Configuration.
        +
        type - Type of the attribute.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/ConfigurationManager.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/ConfigurationManager.html new file mode 100644 index 00000000..9570f6db --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/ConfigurationManager.html @@ -0,0 +1,973 @@ + + + + + +ConfigurationManager + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.conf
+

Class ConfigurationManager

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.conf.ConfigurationManager
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class ConfigurationManager
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        CONNECTED_GATEWAY_CONFIG

        +
        private static final java.lang.String CONNECTED_GATEWAY_CONFIG
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        connectedGatewayConfigurationProvider

        +
        private ConfigurationProvider connectedGatewayConfigurationProvider
        +
        • +
      + + + +
        +
      • +

        appContext

        +
        private android.content.Context appContext
        +
        • +
      + + + +
        +
      • +

        appConfigs

        +
        private java.util.List<Config> appConfigs
        +
        • +
      + + + +
        +
      • +

        configurationFileName

        +
        private java.lang.String configurationFileName
        +
        • +
      + + + +
        +
      • +

        enablePKCE

        +
        private boolean enablePKCE
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        responseInterceptors

        +
        private java.util.LinkedHashMap<java.lang.Class,ResponseInterceptor> responseInterceptors
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        certificateAdvancedRenewTimeframe

        +
        private int certificateAdvancedRenewTimeframe
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConfigurationManager

        +
        private ConfigurationManager()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getContext

        +
        public android.content.Context getContext()
        +
        • +
      + + + +
        +
      • +

        enablePKCE

        +
        public void enablePKCE(boolean enablePKCE)
        +
        • +
      + + + +
        +
      • +

        isPKCEEnabled

        +
        public boolean isPKCEEnabled()
        +
        • +
      + + + +
        +
      • +

        reset

        +
        public void reset()
        +
        • +
      + + + +
        +
      • +

        init

        +
        public void init(android.content.Context context)
        +
        • +
      + + + +
        +
      • +

        setAppConfigs

        +
        public void setAppConfigs(java.util.List<Config> appConfigs)
        +
        • +
      + + + +
        +
      • +

        getConnectedGateway

        +
        public Server getConnectedGateway()
        +
        • +
      + + + +
        +
      • +

        getConnectedGatewayConfig

        +
        public org.json.JSONObject getConnectedGatewayConfig()
        +
        • +
      + + + +
        +
      • +

        getConnectedGatewayConfigurationProvider

        +
        public ConfigurationProvider getConnectedGatewayConfigurationProvider()
        +
        • +
      + + + +
        +
      • +

        store

        +
        private void store(org.json.JSONObject config)
        +
        • +
      + + + +
        +
      • +

        load

        +
        private void load()
        +
        • +
      + + + +
        +
      • +

        activateDefault

        +
        public void activateDefault()
        +
        • +
      + + + +
        +
      • +

        activate

        +
        public void activate(org.json.JSONObject jsonObject)
        +
        • +
      + + + +
        +
      • +

        getConfig

        +
        private org.json.JSONObject getConfig(java.lang.String filename)
        +
        • +
      + + + +
        +
      • +

        getConfig

        +
        public org.json.JSONObject getConfig(java.io.InputStream is)
        +
        • +
      + + + +
        +
      • +

        create

        +
        public ConfigurationProvider create(org.json.JSONObject jsonObject)
+                             throws org.json.JSONException
        +
        +
        Throws:
        +
        org.json.JSONException
        +
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        private <T> T getValue(Config attr,
+                       org.json.JSONObject jsonObject)
+                throws org.json.JSONException
        +
        +
        Throws:
        +
        org.json.JSONException
        +
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        private <T> T getValue(Config attr,
+                       org.json.JSONObject jsonObject,
+                       java.lang.Object def)
+                throws org.json.JSONException
        +
        Perform configure attribute validation and populate the Configure Bundle + for the SDK from the provided JSON Configuration.
        +
        +
        Parameters:
        +
        attr - The Configuration attribute
        +
        jsonObject - The JSON Configuration object.
        +
        Throws:
        +
        org.json.JSONException - When the JSON Configuration is invalid.
        +
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        private static java.lang.Object getValue(java.lang.String path,
+                                         boolean mandatory,
+                                         java.lang.Object parent)
+                                  throws org.json.JSONException
        +
        Retrieve the value from the JSON Configuration by the JSON path. The path use . notation for nested JSON object. + For example, mag.system_endpoints.device_register_endpoint_path
        +
        +
        Parameters:
        +
        path - The JSON path.
        +
        mandatory - True for mandatory and False for not mandatory.
        +
        parent - The parent JSON Object, it can be a JSON Object or JSON Array.
        +
        Returns:
        +
        The Value of the attribute.
        +
        Throws:
        +
        org.json.JSONException - When the JSON message is invalid.
        +
        +
        • +
      + + + +
        +
      • +

        getConfigurationFileName

        +
        public java.lang.String getConfigurationFileName()
        +
        • +
      + + + +
        +
      • +

        setConfigurationFileName

        +
        public void setConfigurationFileName(java.lang.String configurationFileName)
        +
        • +
      + + + + + + + +
        +
      • +

        setConnectionListener

        +
        public void setConnectionListener(MASConnectionListener connectionListener)
        +
        • +
      + + + + + + + +
        +
      • +

        setMobileSsoListener

        +
        public void setMobileSsoListener(MobileSsoListener mobileSsoListener)
        +
        • +
      + + + +
        +
      • +

        getDefaultGrantProvider

        +
        public MASGrantProvider getDefaultGrantProvider()
        +
        • +
      + + + +
        +
      • +

        setDefaultGrantProvider

        +
        public void setDefaultGrantProvider(MASGrantProvider defaultGrantProvider)
        +
        • +
      + + + +
        +
      • +

        getCertificateAdvancedRenewTimeframe

        +
        public int getCertificateAdvancedRenewTimeframe()
        +
        • +
      + + + +
        +
      • +

        setCertificateAdvancedRenewTimeframe

        +
        public void setCertificateAdvancedRenewTimeframe(int certificateAdvancedRenewTimeframe)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getResponseInterceptors

        +
        public java.util.Collection<ResponseInterceptor> getResponseInterceptors()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/ConfigurationProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/ConfigurationProvider.html new file mode 100644 index 00000000..e17503d6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/ConfigurationProvider.html @@ -0,0 +1,513 @@ + + + + + +ConfigurationProvider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.conf
+

Interface ConfigurationProvider

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PROP_LOCATION_MIN_TIME

        +
        static final java.lang.String PROP_LOCATION_MIN_TIME
        +
        Long, milliseconds. Minimum time between location updates, if location enabled. Default is 120000 milliseconds (two minutes).
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PROP_LOCATION_MIN_DISTANCE

        +
        static final java.lang.String PROP_LOCATION_MIN_DISTANCE
        +
        Float, meters. Minimum distance between location updates, if location enabled. Default is 100 meters.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getRaw

        +
        org.json.JSONObject getRaw()
        +
        • +
      + + + +
        +
      • +

        getServer

        +
        Server getServer()
        +
        • +
      + + + +
        +
      • +

        getTokenHost

        +
        java.lang.String getTokenHost()
        +
        +
        Returns:
        +
        the token server hostname, eg "oath.example.com". Never null.
        +
        +
        • +
      + + + +
        +
      • +

        getTokenPort

        +
        int getTokenPort()
        +
        +
        Returns:
        +
        the token server port, eg 8443. Never null.
        +
        +
        • +
      + + + +
        +
      • +

        getClientId

        +
        java.lang.String getClientId()
        +
        +
        Returns:
        +
        the client ID, eg "846955e8-a8fb-4bea-bdd7-a16b39770c3d". Never null.
        +
        +
        • +
      + + + +
        +
      • +

        getClientSecret

        +
        java.lang.String getClientSecret()
        +
        +
        Returns:
        +
        the client secret, eg "6ed4ffcb-4110-4c68-b280-cda17f127374".
        +
        +
        • +
      + + + +
        +
      • +

        getClientScope

        +
        java.lang.String getClientScope()
        +
        +
        Returns:
        +
        the client scope.
        +
        +
        • +
      + + + +
        +
      • +

        getProperty

        +
        <T> T getProperty(java.lang.String propertyName)
        +
        Get an arbitrary configuration property.
        +
        +
        Type Parameters:
        +
        T - the expected return type of the property value.
        +
        Parameters:
        +
        propertyName - the name of the property to get. Required.
        +
        Returns:
        +
        the property value, or null if it is not recognized or not provided.
        +
        +
        • +
      + + + +
        +
      • +

        getTokenUri

        +
        java.net.URI getTokenUri(java.lang.String operation)
        +
        Get the complete URI for the given operation.
        +
        +
        Parameters:
        +
        operation - the operation name, eg MobileSsoConfig.PROP_TOKEN_URL_SUFFIX_REQUEST_TOKEN.
        +
        Returns:
        +
        the URI, or null if no URI is available for the specified operation name.
        +
        +
        • +
      + + + +
        +
      • +

        getUserInfoUri

        +
        java.net.URI getUserInfoUri()
        +
        Get the complete URI for the given operation.
        +
        +
        Returns:
        +
        the URI, or null if no URI is available for the userinfo.
        +
        +
        • +
      + + + +
        +
      • +

        getUri

        +
        java.net.URI getUri(java.lang.String relativePath)
        +
        Retrieves the absolute URI for the given relative path based on the provided SDK configuration. + For path /my/endpoint, the result URI will be https://:/my/endpoint.
        +
        +
        Parameters:
        +
        relativePath - the relative path to the resource.
        +
        Returns:
        +
        the absolute URI.
        +
        +
        • +
      + + + +
        +
      • +

        getPrefix

        +
        java.lang.String getPrefix()
        +
        Based on the provided configuration the the SDK, retrieve the prefix attribute.
        +
        +
        Returns:
        +
        the prefix configured for SDK
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/DefaultConfiguration.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/DefaultConfiguration.html new file mode 100644 index 00000000..e6999a22 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/DefaultConfiguration.html @@ -0,0 +1,956 @@ + + + + + +DefaultConfiguration + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.conf
+

Class DefaultConfiguration

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.conf.DefaultConfiguration
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        clientId

        +
        private final java.lang.String clientId
        +
        • +
      + + + +
        +
      • +

        clientSecret

        +
        private final java.lang.String clientSecret
        +
        • +
      + + + +
        +
      • +

        tokenHost

        +
        private final java.lang.String tokenHost
        +
        • +
      + + + +
        +
      • +

        scope

        +
        private final java.lang.String scope
        +
        • +
      + + + +
        +
      • +

        redirectUri

        +
        private final java.lang.String redirectUri
        +
        • +
      + + + +
        +
      • +

        properties

        +
        private final java.util.Map<java.lang.String,java.lang.Object> properties
        +
        • +
      + + + +
        +
      • +

        raw

        +
        private final org.json.JSONObject raw
        +
        • +
      + + + +
        +
      • +

        server

        +
        private final Server server
        +
        • +
      + + + +
        +
      • +

        operationUriSuffixes

        +
        private java.util.Map<java.lang.String,java.lang.String> operationUriSuffixes
        +
        • +
      + + + +
        +
      • +

        trustedCertificateAnchors

        +
        private java.util.List<java.security.cert.X509Certificate> trustedCertificateAnchors
        +
        • +
      + + + +
        +
      • +

        alsoTrustPublicPki

        +
        private boolean alsoTrustPublicPki
        +
        • +
      + + + +
        +
      • +

        trustedCertificatePinnedPublicKeyHashes

        +
        private java.util.Set<PublicKeyHash> trustedCertificatePinnedPublicKeyHashes
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DefaultConfiguration

        +
        public DefaultConfiguration(org.json.JSONObject raw,
+                            java.lang.String tokenHost,
+                            java.lang.Integer port,
+                            java.lang.String tokenUriPrefix,
+                            java.lang.String clientId,
+                            java.lang.String clientSecret,
+                            java.lang.String organization,
+                            java.lang.String scope,
+                            java.lang.String redirectUri)
        +
        Create a DefaultConfiguration that uses the specified token hostname, client ID, client secret, + and organization name.
        +
        +
        Parameters:
        +
        tokenHost - the token host, eg "oath.example.com". Required.
        +
        tokenUriPrefix - URI prefix of token server URIs, eg "/custom", or null to use the empty string.
        +
        clientId - the application's client id for the initial OAuth token request, eg "846955e8-a8fb-4bea-bdd7-a16b39770c3d". Required.
        +
        clientSecret - the application's client secret for the initial OAuth token request, eg "6ed4ffcb-4110-4c68-b280-cda17f127374". Required.
        +
        organization - the organization name for the O component of the client certificate DN, eg "Exampletronics Ltd". Optional.
        +
        scope - the scope for the O component of the client certificate DN, eg "msso phone profile address email ". Optional.
        +
        redirectUri - the redirectUri name for the O component of the client certificate DN, eg "camsso://com.ca.mas". Optional.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setAlsoTrustPublicPki

        +
        public void setAlsoTrustPublicPki(boolean alsoTrustPublicPki)
        +
        Set whether public CAs recognized by the OS should be accepted as TLS server certs in addition + to the list returned by getTrustedCertificateAnchors().
        +
        +
        Parameters:
        +
        alsoTrustPublicPki - true to trust public PKI CAs in additional to the list returned from getTrustedCertificateAnchors(). + false to trust only the list returned from getTrustedCertificateAnchors().
        +
        +
        • +
      + + + +
        +
      • +

        addTrustedCertificateAnchors

        +
        public void addTrustedCertificateAnchors(java.lang.String... certs)
+                                  throws MAGRuntimeException
        +
        Add one or more trusted certificates to be returned by getTrustedCertificateAnchors().
        +
        +
        Parameters:
        +
        certs - trusted certificates to add, in Base-64 format with or without PEM markers.
        +
        Throws:
        +
        MAGRuntimeException - if PEM or X.509 decoding fails for at least one cert.
        +
        +
        • +
      + + + +
        +
      • +

        addTrustedCertificatePinnedPublicKeyHashes

        +
        public void addTrustedCertificatePinnedPublicKeyHashes(java.lang.String... hashes)
        +
        Add one or more pinned trusted certificate public keys to be returned by getTrustedCertificatePinnedPublicKeyHashes().
        +
        +
        Parameters:
        +
        hashes - public key pin hashes to add, as hex-encoded SHA-256 hashes of the SubjectPublicKeyInfo structure from the certificate.
        +
        +
        • +
      + + + +
        +
      • +

        getClientId

        +
        public java.lang.String getClientId()
        +
        +
        Specified by:
        +
        getClientId in interface ConfigurationProvider
        +
        Returns:
        +
        the client ID, eg "846955e8-a8fb-4bea-bdd7-a16b39770c3d". Never null.
        +
        +
        • +
      + + + +
        +
      • +

        getClientSecret

        +
        public java.lang.String getClientSecret()
        +
        +
        Specified by:
        +
        getClientSecret in interface ConfigurationProvider
        +
        Returns:
        +
        the client secret, eg "6ed4ffcb-4110-4c68-b280-cda17f127374".
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getProperty

        +
        public <T> T getProperty(java.lang.String propertyName)
        +
        Description copied from interface: ConfigurationProvider
        +
        Get an arbitrary configuration property.
        +
        +
        Specified by:
        +
        getProperty in interface ConfigurationProvider
        +
        Type Parameters:
        +
        T - the expected return type of the property value.
        +
        Parameters:
        +
        propertyName - the name of the property to get. Required.
        +
        Returns:
        +
        the property value, or null if it is not recognized or not provided.
        +
        +
        • +
      + + + + + +
        +
      • +

        putProperty

        +
        public <T> void putProperty(java.lang.String propertyName,
+                            T value)
        +
        Set a configuration property.
        +
        +
        Type Parameters:
        +
        T - the expected type of the property value
        +
        Parameters:
        +
        propertyName - the property name. Required.
        +
        value - the property value
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getTokenHost

        +
        public java.lang.String getTokenHost()
        +
        +
        Specified by:
        +
        getTokenHost in interface ConfigurationProvider
        +
        Returns:
        +
        the token server hostname, eg "oath.example.com". Never null.
        +
        +
        • +
      + + + +
        +
      • +

        getScope

        +
        public java.lang.String getScope()
        +
        • +
      + + + +
        +
      • +

        getRedirectUri

        +
        public java.lang.String getRedirectUri()
        +
        • +
      + + + +
        +
      • +

        getTokenPort

        +
        public int getTokenPort()
        +
        +
        Specified by:
        +
        getTokenPort in interface ConfigurationProvider
        +
        Returns:
        +
        the token server port, eg 8443. Never null.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getUserInfoUri

        +
        public java.net.URI getUserInfoUri()
        +
        Description copied from interface: ConfigurationProvider
        +
        Get the complete URI for the given operation.
        +
        +
        Specified by:
        +
        getUserInfoUri in interface ConfigurationProvider
        +
        Returns:
        +
        the URI, or null if no URI is available for the userinfo.
        +
        +
        • +
      + + + +
        +
      • +

        getUri

        +
        public java.net.URI getUri(java.lang.String relativePath)
        +
        Description copied from interface: ConfigurationProvider
        +
        Retrieves the absolute URI for the given relative path based on the provided SDK configuration. + For path /my/endpoint, the result URI will be https://:/my/endpoint.
        +
        +
        Specified by:
        +
        getUri in interface ConfigurationProvider
        +
        Parameters:
        +
        relativePath - the relative path to the resource.
        +
        Returns:
        +
        the absolute URI.
        +
        +
        • +
      + + + +
        +
      • +

        getPrefix

        +
        public java.lang.String getPrefix()
        +
        Description copied from interface: ConfigurationProvider
        +
        Based on the provided configuration the the SDK, retrieve the prefix attribute.
        +
        +
        Specified by:
        +
        getPrefix in interface ConfigurationProvider
        +
        Returns:
        +
        the prefix configured for SDK
        +
        +
        • +
      + + + +
        +
      • +

        isAbsolute

        +
        private static boolean isAbsolute(java.lang.String suffix)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getTrustedCertificatePinnedPublicKeyHashes

        +
        public java.util.Collection<PublicKeyHash> getTrustedCertificatePinnedPublicKeyHashes()
        +
        Description copied from interface: TrustedCertificateConfiguration
        +
        Get server certificate pinned public keys. +

        + This is only really useful if TrustedCertificateConfiguration.isAlsoTrustPublicPki() returns true. If you don't trust public + PKI certs and are relying on internal PKI or self-signed certificates built into the app then you probably + do not need to worry about certificate pinning. +

        + If this list is nonempty then a TLS server cert will be accepted only if one of the pinned public keys + appears somewhere in its certificate chain. +

        + This prevents CAs -- any public CA, not necessarily the CA that signed the server cert originally -- from being + able to create a forged server certificate for an arbitrary target domain.

        +
        +
        Specified by:
        +
        getTrustedCertificatePinnedPublicKeyHashes in interface TrustedCertificateConfiguration
        +
        Returns:
        +
        a list of pinned server certificate public keys, or empty (or null) if pinning should not be used.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/Server.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/Server.html new file mode 100644 index 00000000..adb98e6e --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/Server.html @@ -0,0 +1,463 @@ + + + + + +Server + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.conf
+

Class Server

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.conf.Server
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class Server
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.Stringhost 
      private intport 
      private java.lang.Stringprefix 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      Server(org.json.JSONObject config) 
      Server(java.lang.String host, + int port, + java.lang.String prefix) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object o) 
      java.lang.StringgetHost() 
      intgetPort() 
      java.lang.StringgetPrefix() 
      inthashCode() 
      voidsetHost(java.lang.String host) 
      voidsetPort(int port) 
      voidsetPrefix(java.lang.String prefix) 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        host

        +
        private java.lang.String host
        +
        • +
      + + + +
        +
      • +

        port

        +
        private int port
        +
        • +
      + + + +
        +
      • +

        prefix

        +
        private java.lang.String prefix
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Server

        +
        public Server(org.json.JSONObject config)
        +
        • +
      + + + +
        +
      • +

        Server

        +
        public Server(java.lang.String host,
+              int port,
+              java.lang.String prefix)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHost

        +
        public java.lang.String getHost()
        +
        • +
      + + + +
        +
      • +

        setHost

        +
        public void setHost(java.lang.String host)
        +
        • +
      + + + +
        +
      • +

        getPort

        +
        public int getPort()
        +
        • +
      + + + +
        +
      • +

        setPort

        +
        public void setPort(int port)
        +
        • +
      + + + +
        +
      • +

        getPrefix

        +
        public java.lang.String getPrefix()
        +
        • +
      + + + +
        +
      • +

        setPrefix

        +
        public void setPrefix(java.lang.String prefix)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/package-frame.html new file mode 100644 index 00000000..faa667cb --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/package-frame.html @@ -0,0 +1,29 @@ + + + + + +com.ca.mas.core.conf + + + + + +

com.ca.mas.core.conf

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/package-summary.html new file mode 100644 index 00000000..4d2aab25 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/package-summary.html @@ -0,0 +1,184 @@ + + + + + +com.ca.mas.core.conf + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.conf

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/package-tree.html new file mode 100644 index 00000000..954f8630 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/conf/package-tree.html @@ -0,0 +1,153 @@ + + + + + +com.ca.mas.core.conf Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.conf

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/DeviceIdentifier.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/DeviceIdentifier.html new file mode 100644 index 00000000..bca927fd --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/DeviceIdentifier.html @@ -0,0 +1,313 @@ + + + + + +DeviceIdentifier + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.context
+

Class DeviceIdentifier

+
+
+ +
+
    +
  • +
    +
    +
    public class DeviceIdentifier
+extends UniqueIdentifier
    +
    Generates a set of asymmetric keys in the Android keystore and builds the device identifier off of the public key. + Apps built with the same sharedUserId value in AndroidManifest.xml will reuse the same identifier.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DeviceIdentifier() +
      Generates a set of asymmetric keys in the Android keystore and builds the device identifier off of the public key.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DeviceIdentifier

        +
        public DeviceIdentifier()
+                 throws KeyStoreException,
+                        java.security.NoSuchAlgorithmException
        +
        Generates a set of asymmetric keys in the Android keystore and builds the device identifier off of the public key. + Apps built with the same sharedUserId value in AndroidManifest.xml will reuse the same identifier.
        +
        +
        Throws:
        +
        KeyStoreException
        +
        java.security.NoSuchAlgorithmException
        +
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/MssoContext.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/MssoContext.html new file mode 100644 index 00000000..5af78bc4 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/MssoContext.html @@ -0,0 +1,1251 @@ + + + + + +MssoContext + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.context
+

Class MssoContext

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.context.MssoContext
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MssoContext
+extends java.lang.Object
    +
    Top-level context used by mobile single-sign-on library. + An application would normally only need to create one instance of this class. +

    + The context must be configured and initialized before it can be used. +

    + The executeRequest(Bundle, MASRequest) method will process an outbound + web API request. This may take a long time and involve multiple round trips to the token server, and should not + be executed on the UI thread. + To simplify running remote calls in the background from an Activity, the MssoClient and HttpResponseFragment + are provided.

    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MssoContext

        +
        private MssoContext()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        newContext

        +
        public static MssoContext newContext()
        +
        Create a new MssoContext. +

        + The context must be initialized before it can be used.

        +
        +
        Returns:
        +
        a new MssoContext instance.
        +
        See Also:
        +
        init(android.content.Context)
        +
        +
        • +
      + + + +
        +
      • +

        isInitialized

        +
        public boolean isInitialized()
        +
        Check if this context has been initialized. The context must be initialized before it can be used.
        +
        +
        Returns:
        +
        true if this context has been initialized. + false if initialization is required.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public void init(android.content.Context context)
        +
        Initialize the context. +

        + This method must be called before the context can be used for the first time. +

        + It is safe to call this method more than once. +

        + If the client device ID has not already been set, this method will generate it. +

        + If the device name has not already been set, this method will set it to android.os.Build.MODEL.

        +
        +
        Parameters:
        +
        context - a context, for accessing system services such as telephony and location. Required. + The context must have a lifetime at least as long as this MssoContext. + Typically this means you should not pass an Activity as the context unless you + plan to close this MssoContext when the activity is destroyed.
        +
        Throws:
        +
        MssoException - if the token store cannot be prepared
        +
        +
        • +
      + + + +
        +
      • +

        initPolicyManager

        +
        public void initPolicyManager()
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        Shut down the context. +

        + Any resources will be freed and items such as location listeners will be unregistered.

        +
        • +
      + + + +
        +
      • +

        getTokenManager

        +
        public TokenManager getTokenManager()
        +
        Get the token manager that will be used to persist keys, cert chains, and OAuth tokens.
        +
        +
        Returns:
        +
        the token manager, or null.
        +
        +
        • +
      + + + +
        +
      • +

        getDeviceName

        +
        public java.lang.String getDeviceName()
        +
        +
        Returns:
        +
        the device name, or null if init(android.content.Context) has not yet been called.
        +
        +
        • +
      + + + +
        +
      • +

        isSsoEnabled

        +
        private boolean isSsoEnabled()
        +
        • +
      + + + +
        +
      • +

        clearUserProfile

        +
        public void clearUserProfile()
        +
        • +
      + + + +
        +
      • +

        clearIdToken

        +
        public void clearIdToken()
        +
        • +
      + + + +
        +
      • +

        getIdToken

        +
        public IdToken getIdToken()
        +
        • +
      + + + +
        +
      • +

        setIdToken

        +
        private void setIdToken(IdToken idToken)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        clearCredentials

        +
        public void clearCredentials()
        +
        • +
      + + + +
        +
      • +

        isDeviceRegistered

        +
        public boolean isDeviceRegistered()
        +
        Check if the device has already been registered.
        +
        +
        Returns:
        +
        true if device registered has already completed and a client cert chain and ID token are present in the token store. + false if registration is required or unable to access the storage
        +
        +
        • +
      + + + +
        +
      • +

        resetHttpClient

        +
        public void resetHttpClient()
        +
        Reset the HTTP client, causing a new one to be created. + Use this if the trusted certificate or client cert configuration changes.
        +
        • +
      + + + +
        +
      • +

        getMAGHttpClient

        +
        public MAGHttpClient getMAGHttpClient()
        +
        Get an HTTP client configured to trust server certs per our configuration, and to present a client + cert for mutual auth if one is available in our token store.
        +
        +
        Returns:
        +
        an MAGHttpClient instance. Never null.
        +
        +
        • +
      + + + +
        +
      • +

        onIdTokenAvailable

        +
        public void onIdTokenAvailable(IdToken idToken)
+                        throws JWTValidationException
        +
        Notify that an ID token is now available. May be called from any thread. +

        + Setting a non-null ID token has the side-effect of causing any cached password in memory to be destroyed.

        +
        +
        Parameters:
        +
        idToken - the ID token. Required.
        +
        Throws:
        +
        JWTValidationException
        +
        +
        • +
      + + + +
        +
      • +

        onDeviceRegistrationCompleted

        +
        public void onDeviceRegistrationCompleted()
        +
        Notify that device registration has just completed. May be called from any thread.
        +
        • +
      + + + +
        +
      • +

        onAccessTokenAvailable

        +
        public void onAccessTokenAvailable(java.lang.String accessToken,
+                                   java.lang.String refreshToken,
+                                   long expiresInSec,
+                                   java.lang.String grantedScope)
        +
        Notify that an access token was just obtained. May be called from any thread. +

        + Setting a non-null access token has the side-effect of causing any cached password in memory to be destroyed.

        +
        +
        Parameters:
        +
        accessToken - the access token that was obtained. Required.
        +
        refreshToken - the refresh token to use to obtain a new access token. Required.
        +
        expiresInSec - number of seconds until the access token should be considered expired. Required.
        +
        +
        • +
      + + + +
        +
      • +

        clearAccessToken

        +
        public void clearAccessToken()
        +
        Clear the access token, forcing the next request to obtain a new one.
        +
        • +
      + + + +
        +
      • +

        getAccessToken

        +
        public java.lang.String getAccessToken()
        +
        Get an access token, if one is presently available.
        +
        +
        Returns:
        +
        an access token, or null.
        +
        +
        • +
      + + + +
        +
      • +

        getAccessTokenExpiry

        +
        public long getAccessTokenExpiry()
        +
        Get the access token expiry date, if one is available.
        +
        +
        Returns:
        +
        the access token expiry date as milliseconds since the epoch, or 0 if not available.
        +
        +
        • +
      + + + +
        +
      • +

        getGrantedScope

        +
        public java.lang.String getGrantedScope()
        +
        • +
      + + + +
        +
      • +

        takeRefreshToken

        +
        public java.lang.String takeRefreshToken()
        +
        Take and consume the refresh token, if one is available. +

        + If a refresh token is returned, it is removed from the private token store as well.

        +
        +
        Returns:
        +
        the refresh token, or null.
        +
        +
        • +
      + + + +
        +
      • +

        getRefreshToken

        +
        public java.lang.String getRefreshToken()
        +
        • +
      + + + +
        +
      • +

        getConfigurationProvider

        +
        public ConfigurationProvider getConfigurationProvider()
        +
        Get the configuration provider.
        +
        +
        Returns:
        +
        the configuration provider for this MSSO context.
        +
        +
        • +
      + + + +
        +
      • +

        executeRequest

        +
        public MASResponse executeRequest(android.os.Bundle extra,
+                                  MASRequest request)
+                           throws java.lang.Exception
        +
        Add an access token to the specified outbound request, transmit it to the target server, and return + the response. +

        + This method may take a long time to execute and should not be invoked on the GUI thread.

        +
        +
        Parameters:
        +
        request - the request to decorate and send. Required.
        +
        Returns:
        +
        the final response to this request.
        +
        Throws:
        +
        MAGStateException - if the request cannot be completed in the current MSSO state + (for example, if a username and password must be provided, or if the token store needs to be unlocked).
        +
        java.io.IOException - if there is an error communicating with the target server.
        +
        java.lang.Exception
        +
        +
        • +
      + + + + + + + +
        +
      • +

        logout

        +
        public void logout(boolean contactServer)
        +
        Log out the current user (and, if SSO is enabled, all SSO apps on this device), leaving the device registered, and + optionally informing the token server of the logout. +

        + This method takes no action if the use is already logged out. +

        + t * This method destroys the access token and cached password (if any). If SSO is enabled, this method also + removes the ID token from the shared token store and, if contactServer is true, makes a single best-effort + attempt to notify the server that the ID token should be invalidated. +

        + If the server needs to be contact, this will be done on the current thread. As this may take some time, + callers running on the UI thread and passing true for contactServer should consider running this method + within an AsyncTask. +

        + NOTE: It is extremely important to make at least one attempt to inform the server + of the logout before destroying the tokens client side to try and prevent the server + from getting out of sync with the client. If SSO is enabled, pass contactServer=false only if + absolutely necessary (such as to avoid blocking the GUI if you have already made + at least one attempt to contact the server).

        +
        +
        Parameters:
        +
        contactServer - true to make a single best-effort attempt to notify the server of the logout so that + it can revoke the tokens. This may fail if we lack network connectivity. +

        + false to destroy the tokens client side but make no effort to inform the server that + it needs to revoke them. +

        + This option is ignored unless SSO is enabled and an ID token exists.

        +
        Throws:
        +
        MssoException - if contactServer is true, SSO is enabled, an ID token is present, + and there is an error while attempting to notify the server to log out the ID token or + error access the data source.
        +
        +
        • +
      + + + +
        +
      • +

        removeDeviceRegistration

        +
        public void removeDeviceRegistration()
        +
        Remove this device registration from the server. The token server will identify the device making the request + by its TLS client certificate. +

        + This does not affect the local cached access token, + cached username and password, or the shared token storage in any way. The client will continue to attempt + to present its TLS client certificate on future calls to the token server or a web API endpoint. +

        + To destroy the client-side record of the device registration, call destroyAllPersistentTokens(). +

        + The communication with the token server will occur on the current thread. As this may take some time, + callers running on the UI thread should consider running this method within an AsyncTask.

        +
        +
        Throws:
        +
        MssoException - if there is an error while attempting to tell the token server to unregister this device.
        +
        +
        • +
      + + + +
        +
      • +

        destroyAllPersistentTokens

        +
        public void destroyAllPersistentTokens()
        +
        Clear all tokens in the shared token store. +

        + NOTE: You should not normally use this method. + This method destroys the client private key, effectively un-registering the device, and should only be used + for testing or recovery purposes. +

        + If you just wish to log out the current SSO user see the logout(boolean) method instead.

        +
        +
        Throws:
        +
        MssoException - if there is an error while accessing the storage .
        +
        +
        • +
      + + + +
        +
      • +

        destroyPersistentTokens

        +
        public void destroyPersistentTokens()
        +
        Clear all tokens in the shared token store which associate with the current connected gateway. +

        + NOTE: You should not normally use this method. + This method destroys the client private key, effectively un-registering the device, and should only be used + for testing or recovery purposes. +

        + If you just wish to log out the current SSO user see the logout(boolean) method instead.

        +
        +
        Throws:
        +
        MssoException - if there is an error while accessing the storage .
        +
        +
        • +
      + + + +
        +
      • +

        isLogin

        +
        public boolean isLogin()
        +
        Check if the user has already been logon.
        +
        +
        Returns:
        +
        true if the id token has been acquired and stored in the the device. false if the id token is not available. + For SSO disabled, id token is not issued by the server, check access token and refresh token instead.
        +
        +
        • +
      + + + +
        +
      • +

        setClientCredentials

        +
        public void setClientCredentials(ClientCredentials clientCredentials)
        +
        • +
      + + + +
        +
      • +

        getStoredClientId

        +
        public java.lang.String getStoredClientId()
        +
        • +
      + + + +
        +
      • +

        getClientId

        +
        public java.lang.String getClientId()
        +
        • +
      + + + +
        +
      • +

        getClientSecret

        +
        public java.lang.String getClientSecret()
        +
        • +
      + + + +
        +
      • +

        getClientExpiration

        +
        public java.lang.Long getClientExpiration()
        +
        • +
      + + + +
        +
      • +

        clearClientCredentials

        +
        public void clearClientCredentials()
        +
        • +
      + + + +
        +
      • +

        isClientCredentialExpired

        +
        public boolean isClientCredentialExpired(java.lang.Long clientExpiration)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/MssoException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/MssoException.html new file mode 100644 index 00000000..063ed03f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/MssoException.html @@ -0,0 +1,304 @@ + + + + + +MssoException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.context
+

Class MssoException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • java.lang.RuntimeException
          • +
        • +
            +
          • com.ca.mas.core.context.MssoException
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class MssoException
+extends java.lang.RuntimeException
    +
    Exception thrown if a problem occurs within the MSSO SDK.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      MssoException() 
      MssoException(java.lang.String detailMessage) 
      MssoException(java.lang.String detailMessage, + java.lang.Throwable throwable) 
      MssoException(java.lang.Throwable throwable) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MssoException

        +
        public MssoException()
        +
        • +
      + + + +
        +
      • +

        MssoException

        +
        public MssoException(java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        MssoException

        +
        public MssoException(java.lang.String detailMessage,
+                     java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        MssoException

        +
        public MssoException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/UniqueIdentifier.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/UniqueIdentifier.html new file mode 100644 index 00000000..4fc7df66 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/UniqueIdentifier.html @@ -0,0 +1,337 @@ + + + + + +UniqueIdentifier + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.context
+

Class UniqueIdentifier

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.context.UniqueIdentifier
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected java.lang.Stringidentifier 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      UniqueIdentifier() +
      Generates a set of asymmetric keys in the Android keystore and builds the device identifier off of the public key.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        identifier

        +
        protected java.lang.String identifier
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UniqueIdentifier

        +
        public UniqueIdentifier()
+                 throws KeyStoreException,
+                        java.security.NoSuchAlgorithmException
        +
        Generates a set of asymmetric keys in the Android keystore and builds the device identifier off of the public key. + Apps built with the same sharedUserId value in AndroidManifest.xml will reuse the same identifier.
        +
        +
        Throws:
        +
        KeyStoreException
        +
        java.security.NoSuchAlgorithmException
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        getIdentifierKey

        +
        protected abstract java.lang.String getIdentifierKey()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/package-frame.html new file mode 100644 index 00000000..8f4e5646 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/package-frame.html @@ -0,0 +1,26 @@ + + + + + +com.ca.mas.core.context + + + + + +

com.ca.mas.core.context

+
+

Classes

+ +

Exceptions

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/package-summary.html new file mode 100644 index 00000000..083773a6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/package-summary.html @@ -0,0 +1,169 @@ + + + + + +com.ca.mas.core.context + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.context

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    DeviceIdentifier +
    Generates a set of asymmetric keys in the Android keystore and builds the device identifier off of the public key.
    +
    MssoContext +
    Top-level context used by mobile single-sign-on library.
    +
    UniqueIdentifier 
    +
    • +
  • + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    MssoException +
    Exception thrown if a problem occurs within the MSSO SDK.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/package-tree.html new file mode 100644 index 00000000..4d9c1aa1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/context/package-tree.html @@ -0,0 +1,153 @@ + + + + + +com.ca.mas.core.context Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.context

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • com.ca.mas.core.context.MssoContext
      • +
    • java.lang.Throwable (implements java.io.Serializable) +
        +
      • java.lang.Exception +
          +
        • java.lang.RuntimeException + +
          • +
        +
        • +
      +
      • +
    • com.ca.mas.core.context.UniqueIdentifier + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/AccountManagerStoreDataSource.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/AccountManagerStoreDataSource.html new file mode 100644 index 00000000..7ea4b39d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/AccountManagerStoreDataSource.html @@ -0,0 +1,622 @@ + + + + + +AccountManagerStoreDataSource + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Class AccountManagerStoreDataSource<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.datasource.AccountManagerStoreDataSource<K,V>
      • +
    +
    • +
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataConverter.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataConverter.html new file mode 100644 index 00000000..73feeb80 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataConverter.html @@ -0,0 +1,227 @@ + + + + + +DataConverter + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Interface DataConverter<K,V>

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    StringDataConverter
    +
    +
    +
    +
    public interface DataConverter<K,V>
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        convert

        +
        V convert(K key,
+          byte[] value)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSource.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSource.html new file mode 100644 index 00000000..2e280058 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSource.html @@ -0,0 +1,392 @@ + + + + + +DataSource + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Interface DataSource<K,T>

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSourceCallback.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSourceCallback.html new file mode 100644 index 00000000..18d14a98 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSourceCallback.html @@ -0,0 +1,245 @@ + + + + + +DataSourceCallback + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Interface DataSourceCallback

+
+
+
+
    +
  • +
    +
    +
    public interface DataSourceCallback
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHandler

        +
        android.os.Handler getHandler()
        +
        • +
      + + + + + + + +
        +
      • +

        onSuccess

        +
        void onSuccess(java.lang.Object value)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSourceException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSourceException.html new file mode 100644 index 00000000..a00ce9a3 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSourceException.html @@ -0,0 +1,291 @@ + + + + + +DataSourceException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Class DataSourceException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • java.lang.RuntimeException
          • +
        • +
            +
          • com.ca.mas.core.datasource.DataSourceException
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class DataSourceException
+extends java.lang.RuntimeException
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DataSourceException

        +
        public DataSourceException(java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        DataSourceException

        +
        public DataSourceException(java.lang.String detailMessage,
+                           java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        DataSourceException

        +
        public DataSourceException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSourceFactory.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSourceFactory.html new file mode 100644 index 00000000..958ac0f9 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/DataSourceFactory.html @@ -0,0 +1,292 @@ + + + + + +DataSourceFactory + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Class DataSourceFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.datasource.DataSourceFactory
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class DataSourceFactory
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DataSourceFactory() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <K,V> DataSource<K,V>getStorage(android.content.Context context, + java.lang.Class<? extends DataSource> c, + org.json.JSONObject param) 
      static <K,V> DataSource<K,V>getStorage(android.content.Context context, + java.lang.Class<? extends DataSource> c, + org.json.JSONObject param, + DataConverter converter) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DataSourceFactory

        +
        public DataSourceFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorage

        +
        public static <K,V> DataSource<K,V> getStorage(android.content.Context context,
+                                               java.lang.Class<? extends DataSource> c,
+                                               org.json.JSONObject param,
+                                               DataConverter converter)
        +
        • +
      + + + +
        +
      • +

        getStorage

        +
        public static <K,V> DataSource<K,V> getStorage(android.content.Context context,
+                                               java.lang.Class<? extends DataSource> c,
+                                               org.json.JSONObject param)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/KeystoreDataSource.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/KeystoreDataSource.html new file mode 100644 index 00000000..7ac84fbc --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/KeystoreDataSource.html @@ -0,0 +1,587 @@ + + + + + +KeystoreDataSource + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Class KeystoreDataSource<K,V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.datasource.KeystoreDataSource<K,V>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DataSource<K,V>
    +
    +
    +
    +
    public class KeystoreDataSource<K,V>
+extends java.lang.Object
+implements DataSource<K,V>
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/LocalStoreDataSource.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/LocalStoreDataSource.html new file mode 100644 index 00000000..9611e99a --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/LocalStoreDataSource.html @@ -0,0 +1,577 @@ + + + + + +LocalStoreDataSource + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Class LocalStoreDataSource

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.datasource.LocalStoreDataSource
      • +
    +
    • +
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/LocalStoreEntity.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/LocalStoreEntity.html new file mode 100644 index 00000000..b8c7b6b7 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/LocalStoreEntity.html @@ -0,0 +1,333 @@ + + + + + +LocalStoreEntity + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Class LocalStoreEntity

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.datasource.LocalStoreEntity
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class LocalStoreEntity
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private byte[]data 
      private java.lang.Stringtype 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LocalStoreEntity(java.lang.String type, + byte[] data) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      byte[]getData() 
      java.lang.StringgetType() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        type

        +
        private java.lang.String type
        +
        • +
      + + + +
        +
      • +

        data

        +
        private byte[] data
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LocalStoreEntity

        +
        public LocalStoreEntity(java.lang.String type,
+                        byte[] data)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getType

        +
        public java.lang.String getType()
        +
        • +
      + + + +
        +
      • +

        getData

        +
        public byte[] getData()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/LocalStoreKey.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/LocalStoreKey.html new file mode 100644 index 00000000..7955ad7e --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/LocalStoreKey.html @@ -0,0 +1,361 @@ + + + + + +LocalStoreKey + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Class LocalStoreKey

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.datasource.LocalStoreKey
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class LocalStoreKey
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.StringcreatedBy 
      private java.lang.Stringkey 
      private java.lang.Integersegment 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LocalStoreKey(java.lang.String key, + java.lang.Integer segment, + java.lang.String createdBy) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetCreatedBy() 
      java.lang.StringgetKey() 
      java.lang.IntegergetSegment() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        key

        +
        private java.lang.String key
        +
        • +
      + + + +
        +
      • +

        segment

        +
        private java.lang.Integer segment
        +
        • +
      + + + +
        +
      • +

        createdBy

        +
        private java.lang.String createdBy
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LocalStoreKey

        +
        public LocalStoreKey(java.lang.String key,
+                     java.lang.Integer segment,
+                     java.lang.String createdBy)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSegment

        +
        public java.lang.Integer getSegment()
        +
        • +
      + + + +
        +
      • +

        getKey

        +
        public java.lang.String getKey()
        +
        • +
      + + + +
        +
      • +

        getCreatedBy

        +
        public java.lang.String getCreatedBy()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/SecureAccountManagerStoreDataSource.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/SecureAccountManagerStoreDataSource.html new file mode 100644 index 00000000..645f5382 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/SecureAccountManagerStoreDataSource.html @@ -0,0 +1,402 @@ + + + + + +SecureAccountManagerStoreDataSource + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Class SecureAccountManagerStoreDataSource<K,V>

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/StringDataConverter.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/StringDataConverter.html new file mode 100644 index 00000000..5cefbc9b --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/StringDataConverter.html @@ -0,0 +1,280 @@ + + + + + +StringDataConverter + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.datasource
+

Class StringDataConverter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.datasource.StringDataConverter
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    DataConverter<java.lang.String,java.lang.String>
    +
    +
    +
    +
    public class StringDataConverter
+extends java.lang.Object
+implements DataConverter<java.lang.String,java.lang.String>
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Stringconvert(java.lang.String key, + byte[] value) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        StringDataConverter

        +
        public StringDataConverter()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        convert

        +
        public java.lang.String convert(java.lang.String key,
+                                byte[] value)
        +
        +
        Specified by:
        +
        convert in interface DataConverter<java.lang.String,java.lang.String>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/package-frame.html new file mode 100644 index 00000000..d3d38372 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/package-frame.html @@ -0,0 +1,41 @@ + + + + + +com.ca.mas.core.datasource + + + + + +

com.ca.mas.core.datasource

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +

Errors

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/package-summary.html new file mode 100644 index 00000000..0b676670 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/package-summary.html @@ -0,0 +1,223 @@ + + + + + +com.ca.mas.core.datasource + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.datasource

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/package-tree.html new file mode 100644 index 00000000..07cf9b70 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/datasource/package-tree.html @@ -0,0 +1,176 @@ + + + + + +com.ca.mas.core.datasource Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.datasource

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/EnterpriseBrowserException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/EnterpriseBrowserException.html new file mode 100644 index 00000000..dc9a716d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/EnterpriseBrowserException.html @@ -0,0 +1,321 @@ + + + + + +EnterpriseBrowserException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.ent
+

Class EnterpriseBrowserException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    InvalidResponseException
    +
    +
    +
    +
    public abstract class EnterpriseBrowserException
+extends MAGException
    +
    The Base Exception class for Enterprise Browser
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EnterpriseBrowserException

        +
        public EnterpriseBrowserException(int errorCode)
        +
        • +
      + + + +
        +
      • +

        EnterpriseBrowserException

        +
        public EnterpriseBrowserException(int errorCode,
+                                  java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        EnterpriseBrowserException

        +
        public EnterpriseBrowserException(int errorCode,
+                                  java.lang.String detailMessage,
+                                  java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        EnterpriseBrowserException

        +
        public EnterpriseBrowserException(int errorCode,
+                                  java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/InvalidResponseException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/InvalidResponseException.html new file mode 100644 index 00000000..088ad37f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/InvalidResponseException.html @@ -0,0 +1,279 @@ + + + + + +InvalidResponseException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.ent
+

Class InvalidResponseException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class InvalidResponseException
+extends EnterpriseBrowserException
    +
    This exception is thrown when an error occurs while processing + the JSON Message from enterprise endpoint.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      InvalidResponseException(java.lang.Throwable throwable) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidResponseException

        +
        public InvalidResponseException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/package-frame.html new file mode 100644 index 00000000..14ad0d54 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.ca.mas.core.ent + + + + + +

com.ca.mas.core.ent

+
+

Exceptions

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/package-summary.html new file mode 100644 index 00000000..b9f1cf12 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/package-summary.html @@ -0,0 +1,149 @@ + + + + + +com.ca.mas.core.ent + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.ent

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    EnterpriseBrowserException +
    The Base Exception class for Enterprise Browser
    +
    InvalidResponseException +
    This exception is thrown when an error occurs while processing + the JSON Message from enterprise endpoint.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/package-tree.html new file mode 100644 index 00000000..c3469423 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/ent/package-tree.html @@ -0,0 +1,151 @@ + + + + + +com.ca.mas.core.ent Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.ent

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGError.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGError.html new file mode 100644 index 00000000..bfd69d19 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGError.html @@ -0,0 +1,275 @@ + + + + + +MAGError + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.error
+

Class MAGError

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Error
        • +
      • +
          +
        • com.ca.mas.core.error.MAGError
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class MAGError
+extends java.lang.Error
    +
    Thrown when a MAG error occurs.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      MAGError(java.lang.String detailMessage, + java.lang.Throwable throwable) 
      MAGError(java.lang.Throwable throwable) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MAGError

        +
        public MAGError(java.lang.String detailMessage,
+                java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        MAGError

        +
        public MAGError(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGErrorCode.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGErrorCode.html new file mode 100644 index 00000000..9950c7e3 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGErrorCode.html @@ -0,0 +1,812 @@ + + + + + +MAGErrorCode + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.error
+

Interface MAGErrorCode

+
+
+
+
    +
  • +
    +
    +
    public interface MAGErrorCode
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        FAILED_FILE_NOT_FOUND

        +
        static final int FAILED_FILE_NOT_FOUND
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        FAILED_JSON_SERIALIZATION

        +
        static final int FAILED_JSON_SERIALIZATION
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        FAILED_JSON_VALIDATION

        +
        static final int FAILED_JSON_VALIDATION
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + +
        +
      • +

        GEOLOCATION_IS_INVALID

        +
        static final int GEOLOCATION_IS_INVALID
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        GEOLOCATION_IS_MISSING

        +
        static final int GEOLOCATION_IS_MISSING
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        APPLICATION_ALREADY_REGISTERED

        +
        static final int APPLICATION_ALREADY_REGISTERED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + +
        +
      • +

        APPLICATION_NOT_REGISTERED

        +
        static final int APPLICATION_NOT_REGISTERED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        APPLICATION_INVALID_MAG_IDENTIFER

        +
        static final int APPLICATION_INVALID_MAG_IDENTIFER
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DEVICE_ALREADY_REGISTERED

        +
        static final int DEVICE_ALREADY_REGISTERED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DEVICE_ALREADY_REGISTERED_WITH_DIFFERENT_FLOW

        +
        static final int DEVICE_ALREADY_REGISTERED_WITH_DIFFERENT_FLOW
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DEVICE_COULD_NOT_BE_DEREGISTERED

        +
        static final int DEVICE_COULD_NOT_BE_DEREGISTERED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DEVICE_NOT_REGISTERED

        +
        static final int DEVICE_NOT_REGISTERED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DEVICE_NOT_LOGGED_IN

        +
        static final int DEVICE_NOT_LOGGED_IN
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DEVICE_RECORD_IS_NOT_VALID

        +
        static final int DEVICE_RECORD_IS_NOT_VALID
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        REGISTRATION_ATTEMPTED_WITH_UNREGISTERED_SCOPE

        +
        static final int REGISTRATION_ATTEMPTED_WITH_UNREGISTERED_SCOPE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        REGISTRATION_WITHOUT_REQUIRED_PARAMETERS

        +
        static final int REGISTRATION_WITHOUT_REQUIRED_PARAMETERS
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + +
        +
      • +

        TOKEN_INVALID_ID_TOKEN

        +
        static final int TOKEN_INVALID_ID_TOKEN
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        TOKEN_ID_TOKEN_EXPIRED

        +
        static final int TOKEN_ID_TOKEN_EXPIRED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        TOKEN_ID_TOKEN_INVALID_AUD

        +
        static final int TOKEN_ID_TOKEN_INVALID_AUD
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        TOKEN_ID_TOKEN_INVALID_AZP

        +
        static final int TOKEN_ID_TOKEN_INVALID_AZP
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        TOKEN_ID_TOKEN_INVALID_SIGNATURE

        +
        static final int TOKEN_ID_TOKEN_INVALID_SIGNATURE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ACCESS_TOKEN_INVALID

        +
        static final int ACCESS_TOKEN_INVALID
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ENTERPRISE_BROWSER_WEB_APP_INVALID_URL

        +
        static final int ENTERPRISE_BROWSER_WEB_APP_INVALID_URL
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ENTERPRISE_BROWSER_NATIVE_APP_DOES_NOT_EXIST

        +
        static final int ENTERPRISE_BROWSER_NATIVE_APP_DOES_NOT_EXIST
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ENTERPRISE_BROWSER_NATIVE_APP_CANNOT_OPEN

        +
        static final int ENTERPRISE_BROWSER_NATIVE_APP_CANNOT_OPEN
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ENTERPRISE_BROWSER_APP_DOES_NOT_EXIST

        +
        static final int ENTERPRISE_BROWSER_APP_DOES_NOT_EXIST
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ENTERPRISE_BROWSER_INVALID_RESPONSE

        +
        static final int ENTERPRISE_BROWSER_INVALID_RESPONSE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGException.html new file mode 100644 index 00000000..c6efe38f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGException.html @@ -0,0 +1,379 @@ + + + + + +MAGException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.error
+

Class MAGException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • com.ca.mas.core.error.MAGException
          • +
        +
        • +
      +
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private interrorCode 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      MAGException(int errorCode) 
      MAGException(int errorCode, + java.lang.String detailMessage) 
      MAGException(int errorCode, + java.lang.String detailMessage, + java.lang.Throwable throwable) 
      MAGException(int errorCode, + java.lang.Throwable throwable) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetErrorCode() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        errorCode

        +
        private int errorCode
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MAGException

        +
        public MAGException(int errorCode)
        +
        • +
      + + + +
        +
      • +

        MAGException

        +
        public MAGException(int errorCode,
+                    java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        MAGException

        +
        public MAGException(int errorCode,
+                    java.lang.String detailMessage,
+                    java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        MAGException

        +
        public MAGException(int errorCode,
+                    java.lang.Throwable throwable)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getErrorCode

        +
        public int getErrorCode()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGRuntimeException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGRuntimeException.html new file mode 100644 index 00000000..d2452cb3 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGRuntimeException.html @@ -0,0 +1,379 @@ + + + + + +MAGRuntimeException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.error
+

Class MAGRuntimeException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • java.lang.RuntimeException
          • +
        • +
            +
          • com.ca.mas.core.error.MAGRuntimeException
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class MAGRuntimeException
+extends java.lang.RuntimeException
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private interrorCode 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetErrorCode() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        errorCode

        +
        private int errorCode
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MAGRuntimeException

        +
        public MAGRuntimeException(int errorCode)
        +
        • +
      + + + +
        +
      • +

        MAGRuntimeException

        +
        public MAGRuntimeException(int errorCode,
+                           java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        MAGRuntimeException

        +
        public MAGRuntimeException(int errorCode,
+                           java.lang.String detailMessage,
+                           java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        MAGRuntimeException

        +
        public MAGRuntimeException(int errorCode,
+                           java.lang.Throwable throwable)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getErrorCode

        +
        public int getErrorCode()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGServerException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGServerException.html new file mode 100644 index 00000000..91d91ce4 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGServerException.html @@ -0,0 +1,456 @@ + + + + + +MAGServerException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.error
+

Class MAGServerException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • com.ca.mas.core.error.MAGServerException
          • +
        +
        • +
      +
      • +
    +
    • +
+
+ +
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetContentType() 
      intgetErrorCode() 
      MASResponsegetResponse() 
      intgetStatus() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        errorCode

        +
        private int errorCode
        +
        • +
      + + + +
        +
      • +

        status

        +
        private int status
        +
        • +
      + + + +
        +
      • +

        contentType

        +
        private java.lang.String contentType
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MAGServerException

        +
        public MAGServerException(MASResponse response,
+                          int errorCode,
+                          int status,
+                          java.lang.String contentType,
+                          java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        MAGServerException

        +
        public MAGServerException(MASResponse response,
+                          int errorCode,
+                          int status,
+                          java.lang.String contentType,
+                          java.lang.String detailMessage,
+                          java.lang.Throwable throwable)
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getErrorCode

        +
        public int getErrorCode()
        +
        • +
      + + + +
        +
      • +

        getStatus

        +
        public int getStatus()
        +
        • +
      + + + +
        +
      • +

        getContentType

        +
        public java.lang.String getContentType()
        +
        • +
      + + + +
        +
      • +

        getResponse

        +
        public MASResponse getResponse()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGStateException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGStateException.html new file mode 100644 index 00000000..9c6ff708 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/MAGStateException.html @@ -0,0 +1,316 @@ + + + + + +MAGStateException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.error
+

Class MAGStateException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MAGStateException

        +
        public MAGStateException()
        +
        • +
      + + + +
        +
      • +

        MAGStateException

        +
        public MAGStateException(java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        MAGStateException

        +
        public MAGStateException(java.lang.String detailMessage,
+                         java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        MAGStateException

        +
        public MAGStateException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/TargetApiException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/TargetApiException.html new file mode 100644 index 00000000..07b89a3d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/TargetApiException.html @@ -0,0 +1,336 @@ + + + + + +TargetApiException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.error
+

Class TargetApiException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • com.ca.mas.core.error.TargetApiException
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class TargetApiException
+extends java.lang.Exception
    +
    This exception is thrown when the target application API return http status code which is not within + the range 200 - 299.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private MASResponseresponse 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      MASResponsegetResponse() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TargetApiException

        +
        public TargetApiException(MASResponse response)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getResponse

        +
        public MASResponse getResponse()
        +
        +
        Returns:
        +
        The Http Response of the target API
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/package-frame.html new file mode 100644 index 00000000..d30206c9 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/package-frame.html @@ -0,0 +1,32 @@ + + + + + +com.ca.mas.core.error + + + + + +

com.ca.mas.core.error

+
+

Interfaces

+ +

Exceptions

+ +

Errors

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/package-summary.html new file mode 100644 index 00000000..0c9104dc --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/package-summary.html @@ -0,0 +1,199 @@ + + + + + +com.ca.mas.core.error + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.error

+
+
+
    +
  • + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    MAGErrorCode 
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    MAGException +
    The Base Exception class for MAG
    +
    MAGRuntimeException 
    MAGServerException +
    The Base Exception class for MAG Server communication, + thrown when an error occurs while accessing the MAG Server endpoint
    +
    MAGStateException +
    Superclass for exceptions thrown when an MAG request cannot proceed due to the current state of the MSSO + engine.
    +
    TargetApiException +
    This exception is thrown when the target application API return http status code which is not within + the range 200 - 299.
    +
    +
    • +
  • + + + + + + + + + + + + +
    Error Summary 
    ErrorDescription
    MAGError +
    Thrown when a MAG error occurs.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/package-tree.html new file mode 100644 index 00000000..2f3e2799 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/error/package-tree.html @@ -0,0 +1,163 @@ + + + + + +com.ca.mas.core.error Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.error

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/ContentType.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/ContentType.html new file mode 100644 index 00000000..d8e6c1c0 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/ContentType.html @@ -0,0 +1,411 @@ + + + + + +ContentType + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.http
+

Class ContentType

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.http.ContentType
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class ContentType
+extends java.lang.Object
    +
    Content type of HTTP request or response body
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        APPLICATION_OCTET_STREAM

        +
        public static final ContentType APPLICATION_OCTET_STREAM
        +
        • +
      + + + +
        +
      • +

        APPLICATION_FORM_URLENCODED

        +
        public static final ContentType APPLICATION_FORM_URLENCODED
        +
        • +
      + + + +
        +
      • +

        APPLICATION_JSON

        +
        public static final ContentType APPLICATION_JSON
        +
        • +
      + + + +
        +
      • +

        TEXT_PLAIN

        +
        public static final ContentType TEXT_PLAIN
        +
        • +
      + + + +
        +
      • +

        mimeType

        +
        private final java.lang.String mimeType
        +
        • +
      + + + +
        +
      • +

        charset

        +
        private final java.nio.charset.Charset charset
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ContentType

        +
        public ContentType(java.lang.String mimeType,
+                   java.nio.charset.Charset charset)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMimeType

        +
        public java.lang.String getMimeType()
        +
        +
        Returns:
        +
        The mime type of the request and response body
        +
        +
        • +
      + + + +
        +
      • +

        getCharset

        +
        public java.nio.charset.Charset getCharset()
        +
        +
        Returns:
        +
        The charset of this content type
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/MAGHttpClient.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/MAGHttpClient.html new file mode 100644 index 00000000..14748ca6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/MAGHttpClient.html @@ -0,0 +1,336 @@ + + + + + +MAGHttpClient + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.http
+

Class MAGHttpClient

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.http.MAGHttpClient
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MAGHttpClient
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MAGHttpClient

        +
        public MAGHttpClient()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        execute

        +
        public <T> MASResponse<T> execute(MASRequest request)
+                           throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        execute

        +
        public <T> MASResponse<T> execute(MASRequest request,
+                                  javax.net.ssl.SSLSocketFactory sslSocketFactory)
+                           throws java.io.IOException
        +
        Execute a request to the target API.
        +
        +
        Type Parameters:
        +
        T - The parsed response type
        +
        Parameters:
        +
        request - The request to execute
        +
        Returns:
        +
        The response to the request.
        +
        Throws:
        +
        java.io.IOException - if any error occur or the connection was aborted.
        +
        +
        • +
      + + + +
        +
      • +

        onConnectionObtained

        +
        protected void onConnectionObtained(java.net.HttpURLConnection connection)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/SSLSocketFactoryProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/SSLSocketFactoryProvider.html new file mode 100644 index 00000000..76d8da65 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/SSLSocketFactoryProvider.html @@ -0,0 +1,414 @@ + + + + + +SSLSocketFactoryProvider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.http
+

Class SSLSocketFactoryProvider

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.http.SSLSocketFactoryProvider
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class SSLSocketFactoryProvider
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.util.Map<android.net.Uri,javax.net.ssl.SSLSocketFactory>factories 
      private static SSLSocketFactoryProviderinstance 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      javax.net.ssl.SSLSocketFactorycreateSSLSocketFactory(MASSecurityConfiguration configuration) +
      Creates a SSLSocketFactory for this configuration.
      +
      javax.net.ssl.SSLSocketFactoryget(java.net.URL url) +
      Gets the SSLSocketFactory associated with the specified URL host and port.
      +
      static SSLSocketFactoryProvidergetInstance() 
      javax.net.ssl.SSLSocketFactorygetPrimaryGatewaySocketFactory() +
      Returns the SSLSocketFactory associated with the primary gateway configuration.
      +
      javax.net.ssl.SSLSocketFactorygetSSLSocketFactory(android.net.Uri hostname) +
      Attempts to return the SSLSocketFactory associated with the host configuration.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + + + + + +
        +
      • +

        factories

        +
        private java.util.Map<android.net.Uri,javax.net.ssl.SSLSocketFactory> factories
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SSLSocketFactoryProvider

        +
        private SSLSocketFactoryProvider()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        get

        +
        public javax.net.ssl.SSLSocketFactory get(java.net.URL url)
        +
        Gets the SSLSocketFactory associated with the specified URL host and port.
        +
        +
        Parameters:
        +
        url - url
        +
        Returns:
        +
        the SSLSocketFactory
        +
        +
        • +
      + + + +
        +
      • +

        getPrimaryGatewaySocketFactory

        +
        public javax.net.ssl.SSLSocketFactory getPrimaryGatewaySocketFactory()
+                                                              throws MASInvalidHostException
        +
        Returns the SSLSocketFactory associated with the primary gateway configuration.
        +
        +
        Returns:
        +
        the SSLSocketFactory
        +
        Throws:
        +
        MASInvalidHostException
        +
        +
        • +
      + + + +
        +
      • +

        getSSLSocketFactory

        +
        public javax.net.ssl.SSLSocketFactory getSSLSocketFactory(android.net.Uri hostname)
+                                                   throws MASInvalidHostException
        +
        Attempts to return the SSLSocketFactory associated with the host configuration. + If the SSLSocketFactory is not found, it will create a configuration and map it to the host. + If the host configuration is not found, we will throw an exception.
        +
        +
        Parameters:
        +
        hostname - the host URI
        +
        Returns:
        +
        the SSLSocketFactory or null
        +
        Throws:
        +
        MASInvalidHostException
        +
        +
        • +
      + + + +
        +
      • +

        createSSLSocketFactory

        +
        public javax.net.ssl.SSLSocketFactory createSSLSocketFactory(MASSecurityConfiguration configuration)
        +
        Creates a SSLSocketFactory for this configuration.
        +
        +
        Parameters:
        +
        configuration - the specified security configuration
        +
        Returns:
        +
        the primary SSLSocketFactory
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/package-frame.html new file mode 100644 index 00000000..9b4ff7ac --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/package-frame.html @@ -0,0 +1,22 @@ + + + + + +com.ca.mas.core.http + + + + + +

com.ca.mas.core.http

+
+

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/package-summary.html new file mode 100644 index 00000000..17d94352 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/package-summary.html @@ -0,0 +1,150 @@ + + + + + +com.ca.mas.core.http + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.http

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/package-tree.html new file mode 100644 index 00000000..73d6b518 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/http/package-tree.html @@ -0,0 +1,137 @@ + + + + + +com.ca.mas.core.http Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.http

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/Charsets.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/Charsets.html new file mode 100644 index 00000000..485f3c95 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/Charsets.html @@ -0,0 +1,300 @@ + + + + + +Charsets + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.io
+

Class Charsets

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.io.Charsets
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class Charsets
+extends java.lang.Object
    +
    Holds some common Charset instances as static fields.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.nio.charset.CharsetASCII 
      static java.nio.charset.CharsetISO_8859_1 
      static java.nio.charset.CharsetUTF8 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private Charsets() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        UTF8

        +
        public static final java.nio.charset.Charset UTF8
        +
        • +
      + + + +
        +
      • +

        ASCII

        +
        public static final java.nio.charset.Charset ASCII
        +
        • +
      + + + +
        +
      • +

        ISO_8859_1

        +
        public static final java.nio.charset.Charset ISO_8859_1
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Charsets

        +
        private Charsets()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/IoUtils.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/IoUtils.html new file mode 100644 index 00000000..9460a7ab --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/IoUtils.html @@ -0,0 +1,482 @@ + + + + + +IoUtils + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.io
+

Class IoUtils

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.io.IoUtils
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class IoUtils
+extends java.lang.Object
    +
    Utility methods for doing I/O.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static char[]hexadecimal 
      private static char[]hexadecimal_upper 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private IoUtils() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.lang.Stringbase64(java.lang.String str, + java.nio.charset.Charset charset) +
      Base-64 encode the charset-encoded bytes of the specified string.
      +
      static voidcloseQuietly(java.io.Closeable closeable) +
      Close the specified closeable, if it is non-null.
      +
      static java.lang.StringhexDump(byte[] binaryData) +
      Convert the specified binary data into a string containing hexadecimal digits.
      +
      static java.lang.StringhexDump(byte[] binaryData, + int off, + int len) +
      Convert a portion of the specified binary data into a string containing hexadecimal digits.
      +
      static java.lang.StringhexDump(byte[] binaryData, + int off, + int len, + boolean upperCase) +
      Convert a portion of the specified binary data into a string containing hexadecimal digits.
      +
      static byte[]hexToByteArray(java.lang.String s) 
      static byte[]slurpStream(java.io.InputStream stream, + int limit) +
      Read the entirety of the specified InputStream into memory and return it as a byte array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        hexadecimal

        +
        private static final char[] hexadecimal
        +
        • +
      + + + +
        +
      • +

        hexadecimal_upper

        +
        private static final char[] hexadecimal_upper
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IoUtils

        +
        private IoUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        slurpStream

        +
        public static byte[] slurpStream(java.io.InputStream stream,
+                                 int limit)
+                          throws java.io.IOException
        +
        Read the entirety of the specified InputStream into memory and return it as a byte array. +

        + The stream will be read until EOF but will not be closed by this method. +

        + This method will throw an IOException if the stream is longer than the specified limit.

        +
        +
        Parameters:
        +
        stream - the stream to read. Required.
        +
        limit - the maximum number of bytes to read into memory.
        +
        Returns:
        +
        the remaining contents of the stream as a byte array. Never null.
        +
        Throws:
        +
        java.io.IOException - if an IOException occurs while reading the stream, or if the stream length limit is exceeded.
        +
        +
        • +
      + + + +
        +
      • +

        hexDump

        +
        public static java.lang.String hexDump(byte[] binaryData)
        +
        Convert the specified binary data into a string containing hexadecimal digits. + Example: hexDump(new byte[] { (byte)0xAB, (byte)0xCD }).equals("abcd")
        +
        +
        Parameters:
        +
        binaryData - the data to dump
        +
        Returns:
        +
        the hex dump of the data
        +
        +
        • +
      + + + +
        +
      • +

        hexDump

        +
        public static java.lang.String hexDump(byte[] binaryData,
+                                       int off,
+                                       int len)
        +
        Convert a portion of the specified binary data into a string containing hexadecimal digits.
        +
        +
        Parameters:
        +
        binaryData - the data to dump
        +
        off - offset of first byte to include in the dump.
        +
        len - number of bytes to include in the dump.
        +
        Returns:
        +
        the hex dump of the data
        +
        +
        • +
      + + + +
        +
      • +

        hexDump

        +
        public static java.lang.String hexDump(byte[] binaryData,
+                                       int off,
+                                       int len,
+                                       boolean upperCase)
        +
        Convert a portion of the specified binary data into a string containing hexadecimal digits.
        +
        +
        Parameters:
        +
        binaryData - the data to dump
        +
        off - offset of first byte to include in the dump.
        +
        len - number of bytes to include in the dump.
        +
        upperCase - true if the hex should use uppercase letters.
        +
        Returns:
        +
        the hex dump of the data
        +
        +
        • +
      + + + +
        +
      • +

        hexToByteArray

        +
        public static byte[] hexToByteArray(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        base64

        +
        public static java.lang.String base64(java.lang.String str,
+                                      java.nio.charset.Charset charset)
        +
        Base-64 encode the charset-encoded bytes of the specified string.
        +
        +
        Parameters:
        +
        str - the string to encode. Required.
        +
        Returns:
        +
        the Base-64 encoded form of the charset representation of the string. Never null.
        +
        +
        • +
      + + + +
        +
      • +

        closeQuietly

        +
        public static void closeQuietly(java.io.Closeable closeable)
        +
        Close the specified closeable, if it is non-null. +

        + Any IOException will be logged at debug level. + Any other Exception will be logged as a warning.

        +
        +
        Parameters:
        +
        closeable - a closeable or null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/SingleKeyX509KeyManager.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/SingleKeyX509KeyManager.html new file mode 100644 index 00000000..3fe52925 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/SingleKeyX509KeyManager.html @@ -0,0 +1,471 @@ + + + + + +SingleKeyX509KeyManager + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.io.http
+

Class SingleKeyX509KeyManager

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • javax.net.ssl.X509ExtendedKeyManager
      • +
    • +
        +
      • com.ca.mas.core.io.http.SingleKeyX509KeyManager
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    javax.net.ssl.KeyManager, javax.net.ssl.X509KeyManager
    +
    +
    +
    +
    public class SingleKeyX509KeyManager
+extends javax.net.ssl.X509ExtendedKeyManager
    +
    An SSL X509KeyManager that holds a single pre-configured client cert and private key, and always uses + it to respond to challenges.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.Stringalias 
      private java.security.cert.X509Certificate[]certChain 
      private java.security.PrivateKeyprivateKey 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SingleKeyX509KeyManager(java.security.PrivateKey privateKey, + java.security.cert.X509Certificate[] certChain) +
      Create a a KeyManager that only knows about a single X.509 certificate.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringchooseClientAlias(java.lang.String[] strings, + java.security.Principal[] principals, + java.net.Socket socket) 
      java.lang.StringchooseEngineClientAlias(java.lang.String[] strings, + java.security.Principal[] principals, + javax.net.ssl.SSLEngine sslEngine) 
      java.lang.StringchooseEngineServerAlias(java.lang.String string, + java.security.Principal[] principals, + javax.net.ssl.SSLEngine sslEngine) 
      java.lang.StringchooseServerAlias(java.lang.String s, + java.security.Principal[] principals, + java.net.Socket socket) 
      java.security.cert.X509Certificate[]getCertificateChain(java.lang.String s) 
      java.lang.String[]getClientAliases(java.lang.String s, + java.security.Principal[] principals) 
      java.security.PrivateKeygetPrivateKey(java.lang.String s) 
      java.lang.String[]getServerAliases(java.lang.String s, + java.security.Principal[] principals) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        certChain

        +
        private final java.security.cert.X509Certificate[] certChain
        +
        • +
      + + + +
        +
      • +

        privateKey

        +
        private final java.security.PrivateKey privateKey
        +
        • +
      + + + +
        +
      • +

        alias

        +
        private final java.lang.String alias
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SingleKeyX509KeyManager

        +
        public SingleKeyX509KeyManager(java.security.PrivateKey privateKey,
+                               java.security.cert.X509Certificate[] certChain)
        +
        Create a a KeyManager that only knows about a single X.509 certificate.
        +
        +
        Parameters:
        +
        privateKey - the private key for this certificate chain. Required.
        +
        certChain - the certificate chain to present when challenged (when acting as a client), or to use as the server cert (when acting as a server). Required.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getClientAliases

        +
        public java.lang.String[] getClientAliases(java.lang.String s,
+                                           java.security.Principal[] principals)
        +
        • +
      + + + +
        +
      • +

        chooseClientAlias

        +
        public java.lang.String chooseClientAlias(java.lang.String[] strings,
+                                          java.security.Principal[] principals,
+                                          java.net.Socket socket)
        +
        • +
      + + + +
        +
      • +

        getServerAliases

        +
        public java.lang.String[] getServerAliases(java.lang.String s,
+                                           java.security.Principal[] principals)
        +
        • +
      + + + +
        +
      • +

        chooseServerAlias

        +
        public java.lang.String chooseServerAlias(java.lang.String s,
+                                          java.security.Principal[] principals,
+                                          java.net.Socket socket)
        +
        • +
      + + + +
        +
      • +

        getCertificateChain

        +
        public java.security.cert.X509Certificate[] getCertificateChain(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        getPrivateKey

        +
        public java.security.PrivateKey getPrivateKey(java.lang.String s)
        +
        • +
      + + + +
        +
      • +

        chooseEngineClientAlias

        +
        public java.lang.String chooseEngineClientAlias(java.lang.String[] strings,
+                                                java.security.Principal[] principals,
+                                                javax.net.ssl.SSLEngine sslEngine)
        +
        +
        Overrides:
        +
        chooseEngineClientAlias in class javax.net.ssl.X509ExtendedKeyManager
        +
        +
        • +
      + + + +
        +
      • +

        chooseEngineServerAlias

        +
        public java.lang.String chooseEngineServerAlias(java.lang.String string,
+                                                java.security.Principal[] principals,
+                                                javax.net.ssl.SSLEngine sslEngine)
        +
        +
        Overrides:
        +
        chooseEngineServerAlias in class javax.net.ssl.X509ExtendedKeyManager
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/TrustedCertificateConfigurationTrustManager.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/TrustedCertificateConfigurationTrustManager.html new file mode 100644 index 00000000..afb431d1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/TrustedCertificateConfigurationTrustManager.html @@ -0,0 +1,464 @@ + + + + + +TrustedCertificateConfigurationTrustManager + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.io.http
+

Class TrustedCertificateConfigurationTrustManager

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.io.http.TrustedCertificateConfigurationTrustManager
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    javax.net.ssl.TrustManager, javax.net.ssl.X509TrustManager
    +
    +
    +
    +
    public class TrustedCertificateConfigurationTrustManager
+extends java.lang.Object
+implements javax.net.ssl.X509TrustManager
    +
    Trust manager that works with a TrustedCertificateConfiguration.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        publicPkiDelegates

        +
        private final java.util.Collection<javax.net.ssl.X509TrustManager> publicPkiDelegates
        +
        • +
      + + + +
        +
      • +

        privateTrustStoreDelegates

        +
        private final java.util.Collection<javax.net.ssl.X509TrustManager> privateTrustStoreDelegates
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TrustedCertificateConfigurationTrustManager

        +
        public TrustedCertificateConfigurationTrustManager(MASSecurityConfiguration config)
        +
        Create a trust manager that uses the specified trust configuration.
        +
        +
        Parameters:
        +
        config - trusted cert configuration to use for setting up the trust manager. Required.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPrivateX509TrustManagers

        +
        private static java.util.Collection<javax.net.ssl.X509TrustManager> getPrivateX509TrustManagers(java.util.Collection<java.security.cert.Certificate> certs)
        +
        • +
      + + + +
        +
      • +

        getPlatformX509TrustManagers

        +
        private static java.util.Collection<javax.net.ssl.X509TrustManager> getPlatformX509TrustManagers()
        +
        • +
      + + + +
        +
      • +

        createTrustStoreWithCerts

        +
        private static java.security.KeyStore createTrustStoreWithCerts(java.util.Collection<java.security.cert.Certificate> certs)
        +
        • +
      + + + +
        +
      • +

        getX509TrustManagers

        +
        private static java.util.Collection<javax.net.ssl.X509TrustManager> getX509TrustManagers(java.security.KeyStore trustStore)
        +
        • +
      + + + +
        +
      • +

        checkPrivateTrustStoreDelegates

        +
        private void checkPrivateTrustStoreDelegates(java.security.cert.X509Certificate[] chain,
+                                             java.lang.String s)
+                                      throws java.security.cert.CertificateException
        +
        +
        Throws:
        +
        java.security.cert.CertificateException
        +
        +
        • +
      + + + +
        +
      • +

        checkClientTrusted

        +
        public void checkClientTrusted(java.security.cert.X509Certificate[] chain,
+                               java.lang.String s)
+                        throws java.security.cert.CertificateException
        +
        +
        Specified by:
        +
        checkClientTrusted in interface javax.net.ssl.X509TrustManager
        +
        Throws:
        +
        java.security.cert.CertificateException
        +
        +
        • +
      + + + +
        +
      • +

        checkServerTrusted

        +
        public void checkServerTrusted(java.security.cert.X509Certificate[] chain,
+                               java.lang.String s)
+                        throws java.security.cert.CertificateException
        +
        +
        Specified by:
        +
        checkServerTrusted in interface javax.net.ssl.X509TrustManager
        +
        Throws:
        +
        java.security.cert.CertificateException
        +
        +
        • +
      + + + +
        +
      • +

        getAcceptedIssuers

        +
        public java.security.cert.X509Certificate[] getAcceptedIssuers()
        +
        +
        Specified by:
        +
        getAcceptedIssuers in interface javax.net.ssl.X509TrustManager
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/package-frame.html new file mode 100644 index 00000000..e007830c --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.ca.mas.core.io.http + + + + + +

com.ca.mas.core.io.http

+
+

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/package-summary.html new file mode 100644 index 00000000..8d798f10 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/package-summary.html @@ -0,0 +1,149 @@ + + + + + +com.ca.mas.core.io.http + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.io.http

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/package-tree.html new file mode 100644 index 00000000..7b02395d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/http/package-tree.html @@ -0,0 +1,140 @@ + + + + + +com.ca.mas.core.io.http Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.io.http

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/package-frame.html new file mode 100644 index 00000000..92090271 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.ca.mas.core.io + + + + + +

com.ca.mas.core.io

+
+

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/package-summary.html new file mode 100644 index 00000000..84b49cf9 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/package-summary.html @@ -0,0 +1,148 @@ + + + + + +com.ca.mas.core.io + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.io

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Charsets +
    Holds some common Charset instances as static fields.
    +
    IoUtils +
    Utility methods for doing I/O.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/package-tree.html new file mode 100644 index 00000000..b23806f2 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/package-tree.html @@ -0,0 +1,136 @@ + + + + + +com.ca.mas.core.io Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.io

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/MAGSocketFactory.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/MAGSocketFactory.html new file mode 100644 index 00000000..44e1260c --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/MAGSocketFactory.html @@ -0,0 +1,383 @@ + + + + + +MAGSocketFactory + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.io.ssl
+

Class MAGSocketFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.io.ssl.MAGSocketFactory
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MAGSocketFactory
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        SSL_TLS_PROTOCOL

        +
        private static final java.lang.String SSL_TLS_PROTOCOL
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        secureRandom

        +
        private static final java.security.SecureRandom secureRandom
        +
        • +
      + + + + + + + +
        +
      • +

        clientCertPrivateKey

        +
        private java.security.PrivateKey clientCertPrivateKey
        +
        • +
      + + + +
        +
      • +

        clientCertChain

        +
        private java.security.cert.X509Certificate[] clientCertChain
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MAGSocketFactory

        +
        public MAGSocketFactory(@NonNull
+                        MASSecurityConfiguration config)
        +
        Create an SocketFactory factory that will create clients which trust the specified server certs + and use the specified client cert for client cert authentication. +
        + It retrieves the trustConfig, clientCertPrivateKey and clientCertChain + from the TokenManager.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createTLSSocketFactory

        +
        public javax.net.ssl.SSLSocketFactory createTLSSocketFactory()
        +
        • +
      + + + +
        +
      • +

        createSslContext

        +
        private javax.net.ssl.SSLContext createSslContext()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/package-frame.html new file mode 100644 index 00000000..aa242502 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.ca.mas.core.io.ssl + + + + + +

com.ca.mas.core.io.ssl

+
+

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/package-summary.html new file mode 100644 index 00000000..5d08edfb --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/package-summary.html @@ -0,0 +1,144 @@ + + + + + +com.ca.mas.core.io.ssl + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.io.ssl

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/package-tree.html new file mode 100644 index 00000000..d474db26 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/io/ssl/package-tree.html @@ -0,0 +1,144 @@ + + + + + +com.ca.mas.core.io.ssl Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.io.ssl

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/CodeVerifierCache.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/CodeVerifierCache.html new file mode 100644 index 00000000..de6579f6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/CodeVerifierCache.html @@ -0,0 +1,375 @@ + + + + + +CodeVerifierCache + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.oauth
+

Class CodeVerifierCache

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.oauth.CodeVerifierCache
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class CodeVerifierCache
+extends java.lang.Object
    +
    Temporary cache to store code verifier
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private CodeVerifierCache() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static CodeVerifierCachegetInstance() 
      voidstore(java.lang.String state, + java.lang.String codeVerifier) 
      java.lang.Stringtake() 
      java.lang.Stringtake(java.lang.String state) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + + + + + +
        +
      • +

        state

        +
        private java.lang.String state
        +
        • +
      + + + +
        +
      • +

        codeVerifier

        +
        private java.lang.String codeVerifier
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CodeVerifierCache

        +
        private CodeVerifierCache()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        store

        +
        public void store(java.lang.String state,
+                  java.lang.String codeVerifier)
        +
        • +
      + + + +
        +
      • +

        take

        +
        public java.lang.String take(java.lang.String state)
        +
        • +
      + + + +
        +
      • +

        take

        +
        public java.lang.String take()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthClient.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthClient.html new file mode 100644 index 00000000..7163f3ee --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthClient.html @@ -0,0 +1,710 @@ + + + + + +OAuthClient + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.oauth
+

Class OAuthClient

+
+
+ +
+
    +
  • +
    +
    +
    public class OAuthClient
+extends ServerClient
    +
    Utility class that encapsulates talking to the token server into Java method calls. + This handles just the network protocol for communicating with the MAG server to authorize request . + It does not deal with state management, token persistence, looking up credentials in the context, or anything other + higher-level issue.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OAuthClient

        +
        public OAuthClient(MssoContext mssoContext)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        logout

        +
        public void logout(@NonNull
+                   IdToken idToken,
+                   @NonNull
+                   java.lang.String clientId,
+                   @NonNull
+                   java.lang.String clientSecret,
+                   boolean logoutApps)
+            throws OAuthServerException,
+                   OAuthException
        +
        Inform the token server that the specified ID token should be logged out and sessions canceled for + all apps using this token
        +
        +
        Parameters:
        +
        idToken - an ID token, presumably a JWT. Required.
        +
        clientId - the client ID of the app seeking access. Required.
        +
        clientSecret - the client secret of the app seeking access. Required.
        +
        logoutApps - true if all currently active apps should also be logged out, eg removing all access tokens + created using this ID token. + false if currently active access tokens should be allowed to remain valid until they expire.
        +
        Throws:
        +
        OAuthServerException - if there is an error response from the token server
        +
        OAuthException - if there is an error other than a valid error JSON response from the token server
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthClientUtil.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthClientUtil.html new file mode 100644 index 00000000..52d6fe77 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthClientUtil.html @@ -0,0 +1,271 @@ + + + + + +OAuthClientUtil + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.oauth
+

Class OAuthClientUtil

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.oauth.OAuthClientUtil
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class OAuthClientUtil
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private OAuthClientUtil() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static PKCEgenerateCodeChallenge() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        OAuthClientUtil

        +
        private OAuthClientUtil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        generateCodeChallenge

        +
        public static PKCE generateCodeChallenge()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthException.html new file mode 100644 index 00000000..956c8ae9 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthException.html @@ -0,0 +1,317 @@ + + + + + +OAuthException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.oauth
+

Class OAuthException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class OAuthException
+extends MAGException
    +
    This exception is thrown when an error occurs while processing the OAuth Request.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      OAuthException(int errorCode) 
      OAuthException(int errorCode, + java.lang.String detailMessage) 
      OAuthException(int errorCode, + java.lang.String detailMessage, + java.lang.Throwable throwable) 
      OAuthException(int errorCode, + java.lang.Throwable throwable) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OAuthException

        +
        public OAuthException(int errorCode)
        +
        • +
      + + + +
        +
      • +

        OAuthException

        +
        public OAuthException(int errorCode,
+                      java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        OAuthException

        +
        public OAuthException(int errorCode,
+                      java.lang.String detailMessage,
+                      java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        OAuthException

        +
        public OAuthException(int errorCode,
+                      java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthServerException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthServerException.html new file mode 100644 index 00000000..be436b60 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthServerException.html @@ -0,0 +1,315 @@ + + + + + +OAuthServerException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.oauth
+

Class OAuthServerException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class OAuthServerException
+extends MAGServerException
    +
    This exception is thrown when an error occurs while accessing OAuth endpoint.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OAuthServerException

        +
        public OAuthServerException(MASResponse response,
+                            int errorCode,
+                            int status,
+                            java.lang.String contentType,
+                            java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        OAuthServerException

        +
        public OAuthServerException(MASResponse response,
+                            int errorCode,
+                            int status,
+                            java.lang.String contentType,
+                            java.lang.String detailMessage,
+                            java.lang.Throwable throwable)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthTokenClient.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthTokenClient.html new file mode 100644 index 00000000..76b01042 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthTokenClient.html @@ -0,0 +1,419 @@ + + + + + +OAuthTokenClient + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.oauth
+

Class OAuthTokenClient

+
+
+ +
+
    +
  • +
    +
    +
    public class OAuthTokenClient
+extends ServerClient
    +
    Utility class that encapsulates talking to the token server into Java method calls. + This handles just the network protocol for communicating with the MAG server to obtain an access token. + It does not deal with state management, token persistence, looking up credentials in the context, or anything other + higher-level issue.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OAuthTokenClient

        +
        public OAuthTokenClient(MssoContext mssoContext)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        obtainTokensUsingCredentials

        +
        public OAuthTokenResponse obtainTokensUsingCredentials(@NonNull
+                                                       MAGInternalRequest request,
+                                                       @NonNull
+                                                       java.lang.String clientId,
+                                                       @NonNull
+                                                       java.lang.String clientSecret,
+                                                       boolean requestIdToken)
+                                                throws OAuthException,
+                                                       OAuthServerException
        +
        Exchange a username and password for an access token that can be used to access APIs.
        +
        +
        Parameters:
        +
        request - the oauth request. Required.
        +
        clientId - the client ID of the app seeking access. Required.
        +
        clientSecret - the client secret of the app seeking access. Required.
        +
        requestIdToken - if true, then "msso" will be added to the requested scope, and the response may include an ID token as well as an access token.
        +
        Returns:
        +
        a successful JSON response guaranteed to contain a non-empty accessToken and that may additionally contain a new ID token. Never null.
        +
        Throws:
        +
        OAuthServerException - if there is an error response from the token server
        +
        OAuthException - if there is an error other than a valid error JSON response from the token server
        +
        +
        • +
      + + + +
        +
      • +

        obtainAccessTokenUsingIdToken

        +
        public OAuthTokenResponse obtainAccessTokenUsingIdToken(@NonNull
+                                                        IdToken idToken,
+                                                        @NonNull
+                                                        java.lang.String clientId,
+                                                        @NonNull
+                                                        java.lang.String clientSecret,
+                                                        java.lang.String scope)
+                                                 throws OAuthException,
+                                                        OAuthServerException
        +
        Exchange an ID token for an access token that can be used to access APIs.
        +
        +
        Parameters:
        +
        idToken - an ID token, presumably a JWT. Required.
        +
        clientId - the client ID of the app seeking access. Required.
        +
        clientSecret - the client secret of the app seeking access. Required.
        +
        scope - Scope of access to request. If null, defaults to "openid msso".
        +
        Returns:
        +
        a successful JSON response guaranteed to contain a non-empty accessToken. Never null.
        +
        Throws:
        +
        OAuthServerException - if there is an error response from the token server
        +
        OAuthException - if there is an error other than a valid error JSON response from the token server
        +
        +
        • +
      + + + + + + + +
        +
      • +

        obtainTokenUsingRefreshToken

        +
        public OAuthTokenResponse obtainTokenUsingRefreshToken(@NonNull
+                                                       java.lang.String refreshToken,
+                                                       @NonNull
+                                                       java.lang.String clientId,
+                                                       @NonNull
+                                                       java.lang.String clientSecret)
+                                                throws OAuthException,
+                                                       OAuthServerException
        +
        Exchange a refresh token for a new access token that can be used to access APIs.
        +
        +
        Parameters:
        +
        refreshToken - a refresh token. Required.
        +
        clientId - the client ID of the app seeking access. Required.
        +
        clientSecret - the client secret of the app seeking access. Required.
        +
        Returns:
        +
        a successful JSON response guaranteed to contain a non-empty accessToken. Never null.
        +
        Throws:
        +
        OAuthServerException - if there is an error JSON response from the token server
        +
        OAuthException - if there is an error other than a valid error JSON response from the token server
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthTokenResponse.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthTokenResponse.html new file mode 100644 index 00000000..20365407 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/OAuthTokenResponse.html @@ -0,0 +1,430 @@ + + + + + +OAuthTokenResponse + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.oauth
+

Class OAuthTokenResponse

+
+
+ +
+
    +
  • +
    +
    +
    public class OAuthTokenResponse
+extends ServerResponse
    +
    Represents a JSON response from the token server. +

    + This is either a JSON success or error response from the request_token or request_token_sso method, + or a JSON error response from the register_device method.

    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OAuthTokenResponse

        +
        public OAuthTokenResponse(int status,
+                          java.lang.String json)
+                   throws org.json.JSONException
        +
        +
        Throws:
        +
        org.json.JSONException
        +
        +
        • +
      + + + +
        +
      • +

        OAuthTokenResponse

        +
        public OAuthTokenResponse(int status,
+                          int errorCode,
+                          java.lang.String json)
+                   throws org.json.JSONException
        +
        +
        Throws:
        +
        org.json.JSONException
        +
        +
        • +
      + + + +
        +
      • +

        OAuthTokenResponse

        +
        public OAuthTokenResponse(ServerResponse response)
+                   throws org.json.JSONException
        +
        +
        Throws:
        +
        org.json.JSONException
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAccessToken

        +
        public java.lang.String getAccessToken()
        +
        +
        Returns:
        +
        the contents of a string field named "access_token", or null.
        +
        +
        • +
      + + + +
        +
      • +

        getRefreshToken

        +
        public java.lang.String getRefreshToken()
        +
        +
        Returns:
        +
        the contents of a string field named "refresh_token", or null.
        +
        +
        • +
      + + + +
        +
      • +

        getGrantedScope

        +
        public java.lang.String getGrantedScope()
        +
        • +
      + + + +
        +
      • +

        isBearer

        +
        public boolean isBearer()
        +
        +
        Returns:
        +
        true if the JSON object includes a field named "token_type" with the value "bearer".
        +
        +
        • +
      + + + +
        +
      • +

        getExpiresIn

        +
        public long getExpiresIn()
        +
        +
        Returns:
        +
        the contents of a field named "expires_in" as a string, or 0.
        +
        +
        • +
      + + + +
        +
      • +

        getIdToken

        +
        public IdToken getIdToken()
        +
        +
        Returns:
        +
        the contents of a string field named "id_token", or null.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/PKCE.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/PKCE.html new file mode 100644 index 00000000..24e36f5b --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/PKCE.html @@ -0,0 +1,302 @@ + + + + + +PKCE + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.oauth
+

Class PKCE

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.oauth.PKCE
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class PKCE
+extends java.lang.Object
    +
    Created by mujmo02 on 22/10/17.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PKCE(java.lang.String codeChallengeMethod, + java.lang.String codeChallenge, + java.lang.String codeVerifier) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        codeChallenge

        +
        public java.lang.String codeChallenge
        +
        • +
      + + + +
        +
      • +

        codeChallengeMethod

        +
        public java.lang.String codeChallengeMethod
        +
        • +
      + + + +
        +
      • +

        codeVerifier

        +
        public java.lang.String codeVerifier
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PKCE

        +
        public PKCE(java.lang.String codeChallengeMethod,
+            java.lang.String codeChallenge,
+            java.lang.String codeVerifier)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/package-frame.html new file mode 100644 index 00000000..b929e45b --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/package-frame.html @@ -0,0 +1,30 @@ + + + + + +com.ca.mas.core.oauth + + + + + +

com.ca.mas.core.oauth

+
+

Classes

+ +

Exceptions

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/package-summary.html new file mode 100644 index 00000000..04d240e4 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/package-summary.html @@ -0,0 +1,193 @@ + + + + + +com.ca.mas.core.oauth + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.oauth

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    CodeVerifierCache +
    Temporary cache to store code verifier
    +
    OAuthClient +
    Utility class that encapsulates talking to the token server into Java method calls.
    +
    OAuthClientUtil 
    OAuthTokenClient +
    Utility class that encapsulates talking to the token server into Java method calls.
    +
    OAuthTokenResponse +
    Represents a JSON response from the token server.
    +
    PKCE +
    Created by mujmo02 on 22/10/17.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    OAuthException +
    This exception is thrown when an error occurs while processing the OAuth Request.
    +
    OAuthServerException +
    This exception is thrown when an error occurs while accessing OAuth endpoint.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/package-tree.html new file mode 100644 index 00000000..229f3922 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/oauth/package-tree.html @@ -0,0 +1,166 @@ + + + + + +com.ca.mas.core.oauth Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.oauth

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/package-frame.html new file mode 100644 index 00000000..ebc96fad --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/package-frame.html @@ -0,0 +1,29 @@ + + + + + +com.ca.mas.core + + + + + +

com.ca.mas.core

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/package-summary.html new file mode 100644 index 00000000..9e3883e4 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/package-summary.html @@ -0,0 +1,191 @@ + + + + + +com.ca.mas.core + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/package-tree.html new file mode 100644 index 00000000..1e11dd5f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/package-tree.html @@ -0,0 +1,152 @@ + + + + + +com.ca.mas.core Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/MssoAssertion.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/MssoAssertion.html new file mode 100644 index 00000000..dc4e0fdd --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/MssoAssertion.html @@ -0,0 +1,331 @@ + + + + + +MssoAssertion + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.policy
+

Interface MssoAssertion

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        init

        +
        void init(@NonNull
+          MssoContext mssoContext,
+          @NonNull
+          android.content.Context sysContext)
        +
        Initialize the policy. This must be called, once, before the policy is applied to any messages.
        +
        +
        Parameters:
        +
        mssoContext - the MSSO context. Required.
        +
        sysContext - Android context to use for initializaton. Required.
        +
        +
        • +
      + + + +
        +
      • +

        processRequest

        +
        void processRequest(MssoContext mssoContext,
+                    RequestInfo request)
+             throws MAGStateException,
+                    MAGException,
+                    MAGServerException
        +
        Apply the policy to the specified pending outbound request. +

        + This may trigger additional sub-requests, may modify the request or its headers, + and may fail if MSSO resources are required (such as a password from the user, + or the token store to be initialized or unlocked).

        +
        +
        Parameters:
        +
        mssoContext - the MSSO context. Required.
        +
        request - the pending HTTP request. Required.
        +
        Throws:
        +
        MAGStateException - if the policy cannot be applied in the current MSSO engine state
        +
        MAGException
        +
        MAGServerException
        +
        +
        • +
      + + + +
        +
      • +

        processResponse

        +
        void processResponse(MssoContext mssoContext,
+                     RequestInfo request,
+                     MASResponse response)
+              throws MAGStateException,
+                     MAGException,
+                     MAGServerException
        +
        Apply the policy to the specified received response. +

        Mo + For a successful response, this should normally be quite fast. +

        + For an unsuccessful response, depending on the nature of the failure, this may take further action + and may even throw an MssoStateException. +

        + A successful response must never result in an exception from this method, because some application-level + behavior has presumably already occurred on the server as a result of the successful request.

        +
        +
        Parameters:
        +
        mssoContext - the MSSO context. Required.
        +
        request - the original request. Required.
        +
        response - the HTTP response. Required.
        +
        Throws:
        +
        MAGStateException
        +
        MAGException
        +
        MAGServerException
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        void close()
        +
        Shut down this policy, releasing any resources such as registered location callback etc. +

        + After this method is called the policy shall no longer be used to process messages.

        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/PolicyManager.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/PolicyManager.html new file mode 100644 index 00000000..da16ef14 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/PolicyManager.html @@ -0,0 +1,488 @@ + + + + + +PolicyManager + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.policy
+

Class PolicyManager

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.policy.PolicyManager
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class PolicyManager
+extends java.lang.Object
    +
    Keeps track of policies that can be applied to requests.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        mssoContext

        +
        private final MssoContext mssoContext
        +
        • +
      + + + +
        +
      • +

        defaultPolicy

        +
        private final java.util.List<MssoAssertion> defaultPolicy
        +
        • +
      + + + +
        +
      • +

        policySync

        +
        private final java.lang.Object policySync
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PolicyManager

        +
        public PolicyManager(MssoContext mssoContext)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        init

        +
        public void init(android.content.Context sysContext)
        +
        Initialize policies.
        +
        +
        Parameters:
        +
        sysContext - Android context. Required.
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        private void init(android.content.Context sysContext,
+                  java.util.List<MssoAssertion> policy)
        +
        • +
      + + + +
        +
      • +

        processRequest

        +
        private void processRequest(RequestInfo request,
+                            java.util.List<MssoAssertion> policy)
+                     throws MAGException,
+                            MAGServerException
        +
        Process a request. This will apply policies to the request, possibly calling the token server to + obtain additional information, possibly adding headers to the request. +

        + The request will not actually be sent on to the target system by this method. The caller remains + responsible for doing that.

        +
        +
        Parameters:
        +
        request - the request to process. Required.
        +
        Throws:
        +
        MAGStateException - if the request cannot be processed in the current MSSO engine state.
        +
        MAGException - Exception occur in MAG Engine
        +
        MAGServerException
        +
        +
        • +
      + + + +
        +
      • +

        processResponse

        +
        private void processResponse(RequestInfo request,
+                             MASResponse response,
+                             java.util.List<MssoAssertion> policy)
+                      throws MAGException,
+                             MAGServerException
        +
        Process a response. This will apply policies to the response, possibly adjusting the MSSO state or + even calling the token server in the case of a failed response.
        +
        +
        Parameters:
        +
        request - the original request to which this is a response. Required.
        +
        response - the response to examine. Required.
        +
        Throws:
        +
        MAGStateException - only for a failed (non-200) response, if the nature of the response indicates that + the request cannot be processed in the current MSSO engine state (or should be retried).
        +
        MAGException - Exception occur in MAG Engine
        +
        MAGServerException
        +
        +
        • +
      + + + + + + + +
        +
      • +

        close

        +
        public void close()
        +
        • +
      + + + +
        +
      • +

        close

        +
        private void close(java.util.List<MssoAssertion> policy)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/RequestInfo.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/RequestInfo.html new file mode 100644 index 00000000..ac670280 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/RequestInfo.html @@ -0,0 +1,386 @@ + + + + + +RequestInfo + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.policy
+

Class RequestInfo

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.policy.RequestInfo
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class RequestInfo
+extends java.lang.Object
    +
    Holds a request being processed by policy along with other metadata.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        numAttempts

        +
        private int numAttempts
        +
        • +
      + + + +
        +
      • +

        extra

        +
        private final android.os.Bundle extra
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RequestInfo

        +
        public RequestInfo(MssoContext context,
+                   MASRequest request,
+                   android.os.Bundle extra)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getExtra

        +
        public android.os.Bundle getExtra()
        +
        • +
      + + + +
        +
      • +

        getRequest

        +
        public MAGInternalRequest getRequest()
        +
        +
        Returns:
        +
        the request object. Never null.
        +
        +
        • +
      + + + +
        +
      • +

        getNumAttempts

        +
        public int getNumAttempts()
        +
        +
        Returns:
        +
        the number of attempts that have been made to send this request, not including the current attempt.
        +
        +
        • +
      + + + +
        +
      • +

        incrementNumAttempts

        +
        public void incrementNumAttempts()
        +
        Record that another attempt has been made to send this request.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/CertificateExpiredException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/CertificateExpiredException.html new file mode 100644 index 00000000..2b82e07f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/CertificateExpiredException.html @@ -0,0 +1,408 @@ + + + + + +CertificateExpiredException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.policy.exceptions
+

Class CertificateExpiredException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class CertificateExpiredException
+extends RetryRequestException
    +
    Exception that indicate the certificate has expired.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/CredentialRequiredException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/CredentialRequiredException.html new file mode 100644 index 00000000..c807e91b --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/CredentialRequiredException.html @@ -0,0 +1,316 @@ + + + + + +CredentialRequiredException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.policy.exceptions
+

Class CredentialRequiredException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class CredentialRequiredException
+extends MAGStateException
    +
    Exception thrown if the user must be prompted for their username and password.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CredentialRequiredException

        +
        public CredentialRequiredException()
        +
        • +
      + + + +
        +
      • +

        CredentialRequiredException

        +
        public CredentialRequiredException(java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        CredentialRequiredException

        +
        public CredentialRequiredException(java.lang.String detailMessage,
+                                   java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        CredentialRequiredException

        +
        public CredentialRequiredException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/InvalidClientCredentialException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/InvalidClientCredentialException.html new file mode 100644 index 00000000..2e92b2c7 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/InvalidClientCredentialException.html @@ -0,0 +1,384 @@ + + + + + +InvalidClientCredentialException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.policy.exceptions
+

Class InvalidClientCredentialException

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        INVALID_CLIENT_CREDENTIAL_SUFFIX

        +
        public static final java.lang.String INVALID_CLIENT_CREDENTIAL_SUFFIX
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidClientCredentialException

        +
        public InvalidClientCredentialException()
        +
        • +
      + + + +
        +
      • +

        InvalidClientCredentialException

        +
        public InvalidClientCredentialException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        InvalidClientCredentialException

        +
        public InvalidClientCredentialException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/LocationInvalidException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/LocationInvalidException.html new file mode 100644 index 00000000..5e8c053e --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/LocationInvalidException.html @@ -0,0 +1,310 @@ + + + + + +LocationInvalidException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.policy.exceptions
+

Class LocationInvalidException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class LocationInvalidException
+extends MAGException
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LocationInvalidException

        +
        public LocationInvalidException()
        +
        • +
      + + + +
        +
      • +

        LocationInvalidException

        +
        public LocationInvalidException(java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        LocationInvalidException

        +
        public LocationInvalidException(java.lang.String detailMessage,
+                                java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        LocationInvalidException

        +
        public LocationInvalidException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/LocationRequiredException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/LocationRequiredException.html new file mode 100644 index 00000000..18756420 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/LocationRequiredException.html @@ -0,0 +1,310 @@ + + + + + +LocationRequiredException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.policy.exceptions
+

Class LocationRequiredException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class LocationRequiredException
+extends MAGException
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LocationRequiredException

        +
        public LocationRequiredException()
        +
        • +
      + + + +
        +
      • +

        LocationRequiredException

        +
        public LocationRequiredException(java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        LocationRequiredException

        +
        public LocationRequiredException(java.lang.String detailMessage,
+                                 java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        LocationRequiredException

        +
        public LocationRequiredException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/MobileNumberInvalidException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/MobileNumberInvalidException.html new file mode 100644 index 00000000..f9a43c4a --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/MobileNumberInvalidException.html @@ -0,0 +1,311 @@ + + + + + +MobileNumberInvalidException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.policy.exceptions
+

Class MobileNumberInvalidException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class MobileNumberInvalidException
+extends MAGException
    +
    This exception is thrown when an invalid phone number is passed to MAG Server
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MobileNumberInvalidException

        +
        public MobileNumberInvalidException()
        +
        • +
      + + + +
        +
      • +

        MobileNumberInvalidException

        +
        public MobileNumberInvalidException(java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        MobileNumberInvalidException

        +
        public MobileNumberInvalidException(java.lang.String detailMessage,
+                                    java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        MobileNumberInvalidException

        +
        public MobileNumberInvalidException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/MobileNumberRequiredException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/MobileNumberRequiredException.html new file mode 100644 index 00000000..4ef7d40e --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/MobileNumberRequiredException.html @@ -0,0 +1,311 @@ + + + + + +MobileNumberRequiredException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.policy.exceptions
+

Class MobileNumberRequiredException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class MobileNumberRequiredException
+extends MAGException
    +
    This exception is thrown when phone number is missing.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MobileNumberRequiredException

        +
        public MobileNumberRequiredException()
        +
        • +
      + + + +
        +
      • +

        MobileNumberRequiredException

        +
        public MobileNumberRequiredException(java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        MobileNumberRequiredException

        +
        public MobileNumberRequiredException(java.lang.String detailMessage,
+                                     java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        MobileNumberRequiredException

        +
        public MobileNumberRequiredException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/OtpException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/OtpException.html new file mode 100644 index 00000000..f0b3cfb6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/OtpException.html @@ -0,0 +1,337 @@ + + + + + +OtpException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.policy.exceptions
+

Class OtpException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class OtpException
+extends MAGServerException
    +
    This exception is thrown when the target application API return x-ca-err code which belongs to otp flow
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      OtpException(int errorCode, + int status, + java.lang.String contentType, + java.lang.String detailMessage, + OtpResponseHeaders otpResponseHeaders) 
      OtpException(int errorCode, + int status, + java.lang.String contentType, + java.lang.String detailMessage, + java.lang.Throwable throwable, + OtpResponseHeaders otpResponseHeaders) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OtpException

        +
        public OtpException(int errorCode,
+                    int status,
+                    java.lang.String contentType,
+                    java.lang.String detailMessage,
+                    java.lang.Throwable throwable,
+                    OtpResponseHeaders otpResponseHeaders)
        +
        • +
      + + + +
        +
      • +

        OtpException

        +
        public OtpException(int errorCode,
+                    int status,
+                    java.lang.String contentType,
+                    java.lang.String detailMessage,
+                    OtpResponseHeaders otpResponseHeaders)
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/RetryRequestException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/RetryRequestException.html new file mode 100644 index 00000000..157f3580 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/RetryRequestException.html @@ -0,0 +1,345 @@ + + + + + +RetryRequestException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.policy.exceptions
+

Class RetryRequestException

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      abstract voidrecover(MssoContext context) 
      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RetryRequestException

        +
        public RetryRequestException()
        +
        • +
      + + + +
        +
      • +

        RetryRequestException

        +
        public RetryRequestException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        RetryRequestException

        +
        public RetryRequestException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        recover

        +
        public abstract void recover(MssoContext context)
+                      throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/TokenStoreUnavailableException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/TokenStoreUnavailableException.html new file mode 100644 index 00000000..99257fdc --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/TokenStoreUnavailableException.html @@ -0,0 +1,316 @@ + + + + + +TokenStoreUnavailableException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.policy.exceptions
+

Class TokenStoreUnavailableException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class TokenStoreUnavailableException
+extends MAGStateException
    +
    Exception thrown if the token store is needed but is unavailable (not initialized, device locked)
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TokenStoreUnavailableException

        +
        public TokenStoreUnavailableException()
        +
        • +
      + + + +
        +
      • +

        TokenStoreUnavailableException

        +
        public TokenStoreUnavailableException(java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        TokenStoreUnavailableException

        +
        public TokenStoreUnavailableException(java.lang.String detailMessage,
+                                      java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        TokenStoreUnavailableException

        +
        public TokenStoreUnavailableException(java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/package-frame.html new file mode 100644 index 00000000..b46054c4 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/package-frame.html @@ -0,0 +1,28 @@ + + + + + +com.ca.mas.core.policy.exceptions + + + + + +

com.ca.mas.core.policy.exceptions

+
+

Exceptions

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/package-summary.html new file mode 100644 index 00000000..391cfd4f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/package-summary.html @@ -0,0 +1,184 @@ + + + + + +com.ca.mas.core.policy.exceptions + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.policy.exceptions

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/package-tree.html new file mode 100644 index 00000000..5b6ad2cd --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/exceptions/package-tree.html @@ -0,0 +1,162 @@ + + + + + +com.ca.mas.core.policy.exceptions Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.policy.exceptions

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/package-frame.html new file mode 100644 index 00000000..7e334c06 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/package-frame.html @@ -0,0 +1,35 @@ + + + + + +com.ca.mas.core.policy + + + + + +

com.ca.mas.core.policy

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/package-summary.html new file mode 100644 index 00000000..946327e7 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/package-summary.html @@ -0,0 +1,218 @@ + + + + + +com.ca.mas.core.policy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.policy

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/package-tree.html new file mode 100644 index 00000000..108d45fe --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/policy/package-tree.html @@ -0,0 +1,150 @@ + + + + + +com.ca.mas.core.policy Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.policy

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/DeviceRegistrationAwaitingActivationException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/DeviceRegistrationAwaitingActivationException.html new file mode 100644 index 00000000..a9bd225b --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/DeviceRegistrationAwaitingActivationException.html @@ -0,0 +1,314 @@ + + + + + +DeviceRegistrationAwaitingActivationException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.registration
+

Class DeviceRegistrationAwaitingActivationException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • + +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class DeviceRegistrationAwaitingActivationException
+extends MAGException
    +
    Exception thrown if MAG requests cannot proceed because the device is registered but is awaiting + approval and activation by an administrator.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      (package private) static java.lang.StringDEFAULT_MESSAGE 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DeviceRegistrationAwaitingActivationException

        +
        public DeviceRegistrationAwaitingActivationException()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationClient.DeviceRegistrationResult.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationClient.DeviceRegistrationResult.html new file mode 100644 index 00000000..c409d460 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationClient.DeviceRegistrationResult.html @@ -0,0 +1,279 @@ + + + + + +RegistrationClient.DeviceRegistrationResult + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.registration
+

Interface RegistrationClient.DeviceRegistrationResult

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    RegistrationClient
    +
    +
    +
    +
    public static interface RegistrationClient.DeviceRegistrationResult
    +
    Represents the result of a successful device registration.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getMagIdentifier

        +
        java.lang.String getMagIdentifier()
        +
        +
        Returns:
        +
        the opaque device identifier we have been assigned by the server, as a Base-64 string.
        +
        +
        • +
      + + + +
        +
      • +

        getIdToken

        +
        IdToken getIdToken()
        +
        +
        Returns:
        +
        the ID token we should use for single-sign-on, or null if one was not returned.
        +
        +
        • +
      + + + +
        +
      • +

        getClientCertificateChain

        +
        java.security.cert.X509Certificate[] getClientCertificateChain()
        +
        +
        Returns:
        +
        the signed client certificate chain we should use from now on for TLS mutual auth.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationClient.DeviceStatus.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationClient.DeviceStatus.html new file mode 100644 index 00000000..b5416674 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationClient.DeviceStatus.html @@ -0,0 +1,350 @@ + + + + + +RegistrationClient.DeviceStatus + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.registration
+

Enum RegistrationClient.DeviceStatus

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      ACTIVATED +
      Streamlined activation has succeeded.
      +
      REGISTERED +
      Manual activation is required.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static RegistrationClient.DeviceStatusvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static RegistrationClient.DeviceStatus[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        ACTIVATED

        +
        public static final RegistrationClient.DeviceStatus ACTIVATED
        +
        Streamlined activation has succeeded. The device can be used immediately.
        +
        • +
      + + + +
        +
      • +

        REGISTERED

        +
        public static final RegistrationClient.DeviceStatus REGISTERED
        +
        Manual activation is required. The device has been registered and will be activated at a later time.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static RegistrationClient.DeviceStatus[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (RegistrationClient.DeviceStatus c : RegistrationClient.DeviceStatus.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static RegistrationClient.DeviceStatus valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationClient.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationClient.html new file mode 100644 index 00000000..13412492 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationClient.html @@ -0,0 +1,456 @@ + + + + + +RegistrationClient + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.registration
+

Class RegistrationClient

+
+
+ +
+
    +
  • +
    +
    +
    public class RegistrationClient
+extends ServerClient
    +
    Utility class that encapsulates talking to the token server into Java method calls. + This handles just the network protocol for communicating with the MAG server to register the device. + It does not deal with state management, token persistence, looking up credentials in the context, or anything other + higher-level issue.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RegistrationClient

        +
        public RegistrationClient(MssoContext mssoContext)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerDevice

        +
        public RegistrationClient.DeviceRegistrationResult registerDevice(@NonNull
+                                                                  byte[] certificateSigningRequest,
+                                                                  @NonNull
+                                                                  MASRequest request,
+                                                                  @NonNull
+                                                                  java.lang.String clientId,
+                                                                  @NonNull
+                                                                  java.lang.String clientSecret,
+                                                                  @NonNull
+                                                                  java.lang.String deviceId,
+                                                                  @NonNull
+                                                                  java.lang.String deviceName,
+                                                                  boolean createSession)
+                                                           throws RegistrationException,
+                                                                  RegistrationServerException
        +
        Register a device with the token server. +

        + This will use the current MSSO context's configuration provider to look up the register_device URL. +

        + The current MSSO context's current HTTP client will be used to communicate with the token server. +

        + A caller of this method must already have obtained the user's credentials, generated a key pair, + and created a certificate signing request.

        +
        +
        Parameters:
        +
        certificateSigningRequest - a PKCS#10 certificate signing request in raw binary form. Required.
        +
        request - the OAuth Request
        +
        clientId - the client identifier for the app triggering registration. Required.
        +
        clientSecret - the client secret for the app triggering registration. Required.
        +
        deviceId - the device unique identifier string (eg the IMEI number). Required.
        +
        deviceName - the device name (eg "Joe's Nexus S"). Required.
        +
        createSession - true to create an SSO session at the same time as device registration. An ID token will be returned in the result. + false to register the device but create no SSO session. No ID token will be returned in the result.
        +
        Returns:
        +
        the result of contacting the token server to register the device, as a RegistrationClient.DeviceRegistrationResult.
        +
        Throws:
        +
        RegistrationServerException - if there is an error response from the token server
        +
        RegistrationException
        +
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        removeDeviceRegistration

        +
        public void removeDeviceRegistration()
+                              throws RegistrationException,
+                                     RegistrationServerException
        +
        Remove the device registration for the current device, both authorizing the removal via + TLS mutual authentication with the device's TLS client certificate private key. +

        + The server will also revoke all active access tokens as well as any ID token for this device.

        +
        +
        Throws:
        +
        RegistrationServerException - if there is an error response from the token server
        +
        RegistrationException - if there is an error other than a valid error JSON response from the token server
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationException.html new file mode 100644 index 00000000..a8bd0557 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationException.html @@ -0,0 +1,317 @@ + + + + + +RegistrationException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.registration
+

Class RegistrationException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class RegistrationException
+extends MAGException
    +
    This exception is thrown when an error occurs while processing the registration process.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RegistrationException

        +
        public RegistrationException(int errorCode)
        +
        • +
      + + + +
        +
      • +

        RegistrationException

        +
        public RegistrationException(int errorCode,
+                             java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        RegistrationException

        +
        public RegistrationException(int errorCode,
+                             java.lang.String detailMessage,
+                             java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        RegistrationException

        +
        public RegistrationException(int errorCode,
+                             java.lang.Throwable throwable)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationServerException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationServerException.html new file mode 100644 index 00000000..9c1f0a36 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/RegistrationServerException.html @@ -0,0 +1,315 @@ + + + + + +RegistrationServerException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.registration
+

Class RegistrationServerException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class RegistrationServerException
+extends MAGServerException
    +
    This exception is thrown when an error occurs while accessing register endpoint.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RegistrationServerException

        +
        public RegistrationServerException(MASResponse response,
+                                   int errorCode,
+                                   int status,
+                                   java.lang.String contentType,
+                                   java.lang.String detailMessage)
        +
        • +
      + + + +
        +
      • +

        RegistrationServerException

        +
        public RegistrationServerException(MASResponse response,
+                                   int errorCode,
+                                   int status,
+                                   java.lang.String contentType,
+                                   java.lang.String detailMessage,
+                                   java.lang.Throwable throwable)
        +
        • +
      + + + +
        +
      • +

        RegistrationServerException

        +
        public RegistrationServerException(MAGServerException e)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/package-frame.html new file mode 100644 index 00000000..4bb88149 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/package-frame.html @@ -0,0 +1,34 @@ + + + + + +com.ca.mas.core.registration + + + + + +

com.ca.mas.core.registration

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Exceptions

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/package-summary.html new file mode 100644 index 00000000..5d58ceb6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/package-summary.html @@ -0,0 +1,206 @@ + + + + + +com.ca.mas.core.registration + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.registration

+
+
+
    +
  • + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    RegistrationClient.DeviceRegistrationResult +
    Represents the result of a successful device registration.
    +
    +
    • +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    RegistrationClient +
    Utility class that encapsulates talking to the token server into Java method calls.
    +
    +
    • +
  • + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    RegistrationClient.DeviceStatus +
    Represents the type of registration that occurred.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    DeviceRegistrationAwaitingActivationException +
    Exception thrown if MAG requests cannot proceed because the device is registered but is awaiting + approval and activation by an administrator.
    +
    RegistrationException +
    This exception is thrown when an error occurs while processing the registration process.
    +
    RegistrationServerException +
    This exception is thrown when an error occurs while accessing register endpoint.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/package-tree.html new file mode 100644 index 00000000..608e42b7 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/registration/package-tree.html @@ -0,0 +1,174 @@ + + + + + +com.ca.mas.core.registration Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.registration

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/MAGInternalRequest.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/MAGInternalRequest.html new file mode 100644 index 00000000..0f51628b --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/MAGInternalRequest.html @@ -0,0 +1,430 @@ + + + + + +MAGInternalRequest + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.request
+

Class MAGInternalRequest

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    MASRequest
    +
    +
    +
    +
    public class MAGInternalRequest
+extends MAGRequestProxy
    +
    A request message from a MAG SDK to MAG Server.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        magHeaders

        +
        private java.util.Map<java.lang.String,java.util.List<java.lang.String>> magHeaders
        +
        • +
      + + + + +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addHeader

        +
        public void addHeader(java.lang.String name,
+                      java.lang.String value)
        +
        • +
      + + + +
        +
      • +

        getHeaders

        +
        public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()
        +
        +
        Specified by:
        +
        getHeaders in interface MASRequest
        +
        Overrides:
        +
        getHeaders in class MAGRequestProxy
        +
        Returns:
        +
        A list of HTTP headers for this request
        +
        +
        • +
      + + + +
        +
      • +

        getScope

        +
        public java.lang.String getScope()
        +
        +
        Specified by:
        +
        getScope in interface MASRequest
        +
        Overrides:
        +
        getScope in class MAGRequestProxy
        +
        Returns:
        +
        The scope for this request. When return null, default scope set (defined in the + configuration) will be used.
        +
        +
        • +
      + + + +
        +
      • +

        isLocalRequest

        +
        public boolean isLocalRequest()
        +
        • +
      + + + +
        +
      • +

        getRequest

        +
        public MASRequest getRequest()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/AuthenticateRequest.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/AuthenticateRequest.html new file mode 100644 index 00000000..88c317d0 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/AuthenticateRequest.html @@ -0,0 +1,327 @@ + + + + + +AuthenticateRequest + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.request.internal
+

Class AuthenticateRequest

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/LocalRequest.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/LocalRequest.html new file mode 100644 index 00000000..f14b9f2f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/LocalRequest.html @@ -0,0 +1,256 @@ + + + + + +LocalRequest + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.request.internal
+

Interface LocalRequest<T>

+
+
+
+ +
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/MAGRequestProxy.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/MAGRequestProxy.html new file mode 100644 index 00000000..462834a5 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/MAGRequestProxy.html @@ -0,0 +1,518 @@ + + + + + +MAGRequestProxy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.request.internal
+

Class MAGRequestProxy

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.request.internal.MAGRequestProxy
      • +
    +
    • +
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/package-frame.html new file mode 100644 index 00000000..aa9daa7e --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/package-frame.html @@ -0,0 +1,25 @@ + + + + + +com.ca.mas.core.request.internal + + + + + +

com.ca.mas.core.request.internal

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/package-summary.html new file mode 100644 index 00000000..05ca7709 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/package-summary.html @@ -0,0 +1,161 @@ + + + + + +com.ca.mas.core.request.internal + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.request.internal

+
+
+
    +
  • + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    LocalRequest<T> +
    A Request that send to the SDK but not to the Gateway.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    AuthenticateRequest 
    MAGRequestProxy 
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/package-tree.html new file mode 100644 index 00000000..abe79ceb --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/internal/package-tree.html @@ -0,0 +1,147 @@ + + + + + +com.ca.mas.core.request.internal Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.request.internal

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/package-frame.html new file mode 100644 index 00000000..ebd1bcb6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/package-frame.html @@ -0,0 +1,20 @@ + + + + + +com.ca.mas.core.request + + + + + +

com.ca.mas.core.request

+
+

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/package-summary.html new file mode 100644 index 00000000..3b7e4184 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/package-summary.html @@ -0,0 +1,142 @@ + + + + + +com.ca.mas.core.request + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.request

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    MAGInternalRequest +
    A request message from a MAG SDK to MAG Server.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/package-tree.html new file mode 100644 index 00000000..36d40490 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/request/package-tree.html @@ -0,0 +1,139 @@ + + + + + +com.ca.mas.core.request Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.request

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AccountManagerKeyStorageProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AccountManagerKeyStorageProvider.html new file mode 100644 index 00000000..6daf2345 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AccountManagerKeyStorageProvider.html @@ -0,0 +1,385 @@ + + + + + +AccountManagerKeyStorageProvider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class AccountManagerKeyStorageProvider

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        storage

        +
        private DataSource<java.lang.String,byte[]> storage
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AccountManagerKeyStorageProvider

        +
        public AccountManagerKeyStorageProvider(@NonNull
+                                        android.content.Context ctx)
        +
        Constructor
        +
        +
        Parameters:
        +
        ctx -
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        storeSecretKeyLocally

        +
        protected boolean storeSecretKeyLocally(java.lang.String alias,
+                                        byte[] encryptedSecretkey)
        +
        +
        Specified by:
        +
        storeSecretKeyLocally in class KeyStoreKeyStorageProvider
        +
        Parameters:
        +
        alias - The alias to store the key against.
        +
        encryptedSecretkey - The encrypted secret key to store.
        +
        Returns:
        +
        True on success.
        +
        +
        • +
      + + + +
        +
      • +

        getEncryptedSecretKey

        +
        protected byte[] getEncryptedSecretKey(java.lang.String alias)
        +
        +
        Specified by:
        +
        getEncryptedSecretKey in class KeyStoreKeyStorageProvider
        +
        Parameters:
        +
        alias - The alias for the required secret key.
        +
        Returns:
        +
        byte[] of encrypted secret key.
        +
        +
        • +
      + + + +
        +
      • +

        deleteSecretKeyLocally

        +
        protected boolean deleteSecretKeyLocally(java.lang.String alias)
        +
        Delete the secret key locally.
        +
        +
        Specified by:
        +
        deleteSecretKeyLocally in class KeyStoreKeyStorageProvider
        +
        Parameters:
        +
        alias - The alias for the required secret key.
        +
        Returns:
        +
        True on success.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidJellyBeanKeyRepository.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidJellyBeanKeyRepository.html new file mode 100644 index 00000000..88ed0b0a --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidJellyBeanKeyRepository.html @@ -0,0 +1,648 @@ + + + + + +AndroidJellyBeanKeyRepository + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class AndroidJellyBeanKeyRepository

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private KeyStorekeyStore 
      private static java.lang.StringPUTBLIC_KEY 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.security.KeyPaircreatePrivateKey(java.lang.String alias, + GenerateKeyAttribute attributes) +
      Create Private key and store to keystore
      +
      private java.security.PrivateKeydecodeRsaPrivateKey(byte[] pkcs8EncodedKeyBytes) +
      Decode the specified PKCS#8 encoded RSA private key bytes into an RSA PrivateKey instance.
      +
      private java.security.PublicKeydecodeRsaPublicKey(byte[] x509EncodedKeyBytes) +
      Decode the specified X.509 encoded SubjectPublicKeyInfo bytes into an RSA PublicKey instance.
      +
      voiddeleteCertificateChain(java.lang.String alias) +
      Delete certificate chain from keystore
      +
      voiddeleteKey(java.lang.String alias) +
      Delete Key from keystore
      +
      private static byte[]encodeRsaPrivateKey(java.security.PrivateKey privateKey) +
      Convert the specified private key into encoded key bytes in PKCS#8 format.
      +
      private byte[]encodeRsaPublicKey(java.security.PublicKey publicKey) +
      Convert the specified RSA public key into an X.509 SubjectPublicKeyInfo structure.
      +
      byte[]generateCertificateSigningRequest(java.lang.String commonName, + java.lang.String deviceId, + java.lang.String deviceName, + java.lang.String organization, + java.security.PrivateKey privateKey, + java.security.PublicKey publicKey) +
      Generate Certificate Signing Request
      +
      java.security.cert.X509Certificate[]getCertificateChain(java.lang.String alias) +
      Retrieve the stored Certificate Chain
      +
      java.security.KeygetPrivateKey(java.lang.String alias) +
      Retrieve Private from keystore
      +
      java.security.KeygetPublicKey(java.lang.String alias) +
      Retrieve Public from keystore
      +
      voidsaveCertificateChain(java.lang.String alias, + java.security.cert.X509Certificate[] chain) +
      Save certificate chain to keystore
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AndroidJellyBeanKeyRepository

        +
        public AndroidJellyBeanKeyRepository()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        deleteKey

        +
        public void deleteKey(java.lang.String alias)
        +
        Description copied from class: KeyStoreRepository
        +
        Delete Key from keystore
        +
        +
        Specified by:
        +
        deleteKey in class KeyStoreRepository
        +
        Parameters:
        +
        alias - Key Alias
        +
        +
        • +
      + + + + + + + +
        +
      • +

        saveCertificateChain

        +
        public void saveCertificateChain(java.lang.String alias,
+                                 java.security.cert.X509Certificate[] chain)
        +
        Description copied from class: KeyStoreRepository
        +
        Save certificate chain to keystore
        +
        +
        Specified by:
        +
        saveCertificateChain in class KeyStoreRepository
        +
        Parameters:
        +
        alias - Alias to store the certificate chain
        +
        chain - The certificate chain.
        +
        +
        • +
      + + + +
        +
      • +

        getCertificateChain

        +
        public java.security.cert.X509Certificate[] getCertificateChain(java.lang.String alias)
+                                                         throws KeyStoreException
        +
        Description copied from class: KeyStoreRepository
        +
        Retrieve the stored Certificate Chain
        +
        +
        Specified by:
        +
        getCertificateChain in class KeyStoreRepository
        +
        Parameters:
        +
        alias - Alias for the Certificate Chain
        +
        Returns:
        +
        The Certificate Chain stored in the keystore or null if empty
        +
        Throws:
        +
        KeyStoreException
        +
        +
        • +
      + + + +
        +
      • +

        deleteCertificateChain

        +
        public void deleteCertificateChain(java.lang.String alias)
        +
        Description copied from class: KeyStoreRepository
        +
        Delete certificate chain from keystore
        +
        +
        Specified by:
        +
        deleteCertificateChain in class KeyStoreRepository
        +
        Parameters:
        +
        alias - Alias for the Certificate Chain
        +
        +
        • +
      + + + +
        +
      • +

        generateCertificateSigningRequest

        +
        public byte[] generateCertificateSigningRequest(java.lang.String commonName,
+                                                java.lang.String deviceId,
+                                                java.lang.String deviceName,
+                                                java.lang.String organization,
+                                                java.security.PrivateKey privateKey,
+                                                java.security.PublicKey publicKey)
+                                         throws java.security.cert.CertificateException
        +
        Description copied from class: KeyStoreRepository
        +
        Generate Certificate Signing Request
        +
        +
        Specified by:
        +
        generateCertificateSigningRequest in class KeyStoreRepository
        +
        Returns:
        +
        The Certificate Signing Request
        +
        Throws:
        +
        java.security.cert.CertificateException
        +
        +
        • +
      + + + +
        +
      • +

        encodeRsaPrivateKey

        +
        private static byte[] encodeRsaPrivateKey(java.security.PrivateKey privateKey)
        +
        Convert the specified private key into encoded key bytes in PKCS#8 format.
        +
        +
        Parameters:
        +
        privateKey - the private key to encode. Required.
        +
        Returns:
        +
        the encoded form of this key. Never null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the key is not RSA or cannot be encoded (perhaps it is a hardware key that cannot be exported)
        +
        +
        • +
      + + + +
        +
      • +

        decodeRsaPrivateKey

        +
        private java.security.PrivateKey decodeRsaPrivateKey(byte[] pkcs8EncodedKeyBytes)
+                                              throws java.security.NoSuchAlgorithmException,
+                                                     java.security.spec.InvalidKeySpecException
        +
        Decode the specified PKCS#8 encoded RSA private key bytes into an RSA PrivateKey instance.
        +
        +
        Parameters:
        +
        pkcs8EncodedKeyBytes - the PKCS#8 encoded RSA private key bytes. Required.
        +
        Returns:
        +
        the decoded PrivateKey instance, created using the current default RSA KeyFactory. Never null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the key cannot be decoded
        +
        java.security.NoSuchAlgorithmException
        +
        java.security.spec.InvalidKeySpecException
        +
        +
        • +
      + + + +
        +
      • +

        encodeRsaPublicKey

        +
        private byte[] encodeRsaPublicKey(java.security.PublicKey publicKey)
        +
        Convert the specified RSA public key into an X.509 SubjectPublicKeyInfo structure.
        +
        +
        Parameters:
        +
        publicKey - the public key to encode. Required.
        +
        Returns:
        +
        the X.509 encoded bytes of the public key. Never null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the key is not RSA or cannot be encoded.
        +
        +
        • +
      + + + +
        +
      • +

        decodeRsaPublicKey

        +
        private java.security.PublicKey decodeRsaPublicKey(byte[] x509EncodedKeyBytes)
+                                            throws java.security.NoSuchAlgorithmException,
+                                                   java.security.spec.InvalidKeySpecException
        +
        Decode the specified X.509 encoded SubjectPublicKeyInfo bytes into an RSA PublicKey instance.
        +
        +
        Parameters:
        +
        x509EncodedKeyBytes - the X.509 encoded bytes of the public key. Required.
        +
        Returns:
        +
        the decoded PublicKey instance, created using the default RSA KeyFactory. Never null.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the key cannot be decoded
        +
        java.security.NoSuchAlgorithmException
        +
        java.security.spec.InvalidKeySpecException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidJellyBeanMR2KeyRepository.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidJellyBeanMR2KeyRepository.html new file mode 100644 index 00000000..404fea79 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidJellyBeanMR2KeyRepository.html @@ -0,0 +1,321 @@ + + + + + +AndroidJellyBeanMR2KeyRepository + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class AndroidJellyBeanMR2KeyRepository

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidKitKatKeyRepository.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidKitKatKeyRepository.html new file mode 100644 index 00000000..e15e42bd --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidKitKatKeyRepository.html @@ -0,0 +1,311 @@ + + + + + +AndroidKitKatKeyRepository + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class AndroidKitKatKeyRepository

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidMKeyRepository.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidMKeyRepository.html new file mode 100644 index 00000000..a75ad33d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidMKeyRepository.html @@ -0,0 +1,318 @@ + + + + + +AndroidMKeyRepository + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class AndroidMKeyRepository

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AndroidMKeyRepository

        +
        public AndroidMKeyRepository()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidNKeyRepository.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidNKeyRepository.html new file mode 100644 index 00000000..ce97d8f1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/AndroidNKeyRepository.html @@ -0,0 +1,311 @@ + + + + + +AndroidNKeyRepository + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class AndroidNKeyRepository

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/DefaultEncryptionProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/DefaultEncryptionProvider.html new file mode 100644 index 00000000..d0e3a8b1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/DefaultEncryptionProvider.html @@ -0,0 +1,407 @@ + + + + + +DefaultEncryptionProvider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class DefaultEncryptionProvider

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.security.DefaultEncryptionProvider
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static java.lang.StringKEY_ALIAS 
      private KeyStorageProviderksp 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      byte[]decrypt(byte[] encryptedData) 
      private voiddestroyKey(javax.crypto.SecretKey key) +
      Destroys the ephemeral key, in this case the Secret key generated for MAC, if the key implements Destroyable
      +
      byte[]encrypt(byte[] data) +
      Encrypts the given data.
      +
      protected java.lang.StringgetKeyAlias() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DefaultEncryptionProvider

        +
        public DefaultEncryptionProvider(@NonNull
+                                 android.content.Context ctx)
        +
        • +
      + + + +
        +
      • +

        DefaultEncryptionProvider

        +
        public DefaultEncryptionProvider(android.content.Context ctx,
+                                 KeyStorageProvider keyStorageProvider)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyAlias

        +
        protected java.lang.String getKeyAlias()
        +
        • +
      + + + +
        +
      • +

        encrypt

        +
        public byte[] encrypt(byte[] data)
        +
        Encrypts the given data.
        +
        +
        Specified by:
        +
        encrypt in interface EncryptionProvider
        +
        Parameters:
        +
        data - : the data to encrypt
        +
        Returns:
        +
        encrypted data as byte[]
        +
        +
        • +
      + + + +
        +
      • +

        decrypt

        +
        public byte[] decrypt(byte[] encryptedData)
        +
        +
        Specified by:
        +
        decrypt in interface EncryptionProvider
        +
        Parameters:
        +
        encryptedData - : data to be decrypted
        +
        Returns:
        +
        byte[] of decrypted data
        +
        +
        • +
      + + + +
        +
      • +

        destroyKey

        +
        private void destroyKey(javax.crypto.SecretKey key)
        +
        Destroys the ephemeral key, in this case the Secret key generated for MAC, if the key implements Destroyable
        +
        +
        Parameters:
        +
        key -
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/EncryptionProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/EncryptionProvider.html new file mode 100644 index 00000000..4708c4cb --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/EncryptionProvider.html @@ -0,0 +1,248 @@ + + + + + +EncryptionProvider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.security
+

Interface EncryptionProvider

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encrypt

        +
        byte[] encrypt(byte[] plaintext)
        +
        +
        Parameters:
        +
        plaintext - bytes to encrypt
        +
        Returns:
        +
        encrypted data
        +
        +
        • +
      + + + +
        +
      • +

        decrypt

        +
        byte[] decrypt(byte[] encryptedData)
        +
        +
        Parameters:
        +
        encryptedData - bytes to decrypt
        +
        Returns:
        +
        decrypted data
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/GenerateKeyAttribute.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/GenerateKeyAttribute.html new file mode 100644 index 00000000..5233ce89 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/GenerateKeyAttribute.html @@ -0,0 +1,514 @@ + + + + + +GenerateKeyAttribute + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class GenerateKeyAttribute

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.security.GenerateKeyAttribute
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class GenerateKeyAttribute
+extends java.lang.Object
    +
    Attributes to generate keys
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        keySize

        +
        private int keySize
        +
        • +
      + + + +
        +
      • +

        userAuthenticationRequired

        +
        private boolean userAuthenticationRequired
        +
        • +
      + + + +
        +
      • +

        encryptionRequired

        +
        private boolean encryptionRequired
        +
        • +
      + + + +
        +
      • +

        userAuthenticationValidityDurationSeconds

        +
        private int userAuthenticationValidityDurationSeconds
        +
        • +
      + + + +
        +
      • +

        invalidatedByBiometricEnrollment

        +
        private boolean invalidatedByBiometricEnrollment
        +
        • +
      + + + +
        +
      • +

        dn

        +
        private java.lang.String dn
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GenerateKeyAttribute

        +
        public GenerateKeyAttribute()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEncryptionRequired

        +
        public boolean isEncryptionRequired()
        +
        • +
      + + + +
        +
      • +

        setEncryptionRequired

        +
        public void setEncryptionRequired(boolean encryptionRequired)
        +
        • +
      + + + +
        +
      • +

        getKeySize

        +
        public int getKeySize()
        +
        • +
      + + + +
        +
      • +

        getDn

        +
        public java.lang.String getDn()
        +
        • +
      + + + +
        +
      • +

        setDn

        +
        public void setDn(java.lang.String dn)
        +
        • +
      + + + +
        +
      • +

        setKeySize

        +
        public void setKeySize(int keySize)
        +
        • +
      + + + +
        +
      • +

        isUserAuthenticationRequired

        +
        public boolean isUserAuthenticationRequired()
        +
        • +
      + + + +
        +
      • +

        setUserAuthenticationRequired

        +
        public void setUserAuthenticationRequired(boolean userAuthenticationRequired)
        +
        • +
      + + + +
        +
      • +

        getUserAuthenticationValidityDurationSeconds

        +
        public int getUserAuthenticationValidityDurationSeconds()
        +
        • +
      + + + +
        +
      • +

        setUserAuthenticationValidityDurationSeconds

        +
        public void setUserAuthenticationValidityDurationSeconds(int userAuthenticationValidityDurationSeconds)
        +
        • +
      + + + +
        +
      • +

        isInvalidatedByBiometricEnrollment

        +
        public boolean isInvalidatedByBiometricEnrollment()
        +
        • +
      + + + +
        +
      • +

        setInvalidatedByBiometricEnrollment

        +
        public void setInvalidatedByBiometricEnrollment(boolean invalidatedByBiometricEnrollment)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStorageProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStorageProvider.html new file mode 100644 index 00000000..ffb9cdf8 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStorageProvider.html @@ -0,0 +1,255 @@ + + + + + +KeyStorageProvider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.security
+

Interface KeyStorageProvider

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      javax.crypto.SecretKeygetKey(java.lang.String alias, + boolean userAuthenticationRequired) +
      Retrieve the SecretKey from Storage
      +
      booleanremoveKey(java.lang.String alias) +
      Remove the key
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKey

        +
        javax.crypto.SecretKey getKey(java.lang.String alias,
+                              boolean userAuthenticationRequired)
        +
        Retrieve the SecretKey from Storage
        +
        +
        Parameters:
        +
        alias - : The alias to find the Key
        +
        Returns:
        +
        The SecretKey
        +
        +
        • +
      + + + +
        +
      • +

        removeKey

        +
        boolean removeKey(java.lang.String alias)
        +
        Remove the key
        +
        +
        Parameters:
        +
        alias - the alias of the key to remove
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStore.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStore.html new file mode 100644 index 00000000..11af63da --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStore.html @@ -0,0 +1,496 @@ + + + + + +KeyStore + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.ca.mas.core.security
+

Interface KeyStore

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    KeyStoreAdapter
    +
    +
    +
    +
    public interface KeyStore
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isUnlocked

        +
        boolean isUnlocked()
        +
        • +
      + + + +
        +
      • +

        contains

        +
        boolean contains(java.lang.String key)
        +
        • +
      + + + +
        +
      • +

        delete

        +
        boolean delete(java.lang.String key)
        +
        • +
      + + + +
        +
      • +

        put

        +
        boolean put(java.lang.String key,
+            byte[] value)
        +
        • +
      + + + +
        +
      • +

        get

        +
        byte[] get(java.lang.String key)
        +
        • +
      + + + +
        +
      • +

        getLastError

        +
        int getLastError()
        +
        • +
      + + + +
        +
      • +

        saw

        +
        java.lang.String[] saw(java.lang.String prefix)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreAdapter.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreAdapter.html new file mode 100644 index 00000000..93be4794 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreAdapter.html @@ -0,0 +1,563 @@ + + + + + +KeyStoreAdapter + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class KeyStoreAdapter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.security.KeyStoreAdapter
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    KeyStore
    +
    +
    +
    +
    public class KeyStoreAdapter
+extends java.lang.Object
+implements KeyStore
    +
    Adapter that provides a common interface KeyStore for various + Android KeyStore implementations from API level 16 and up + + This class uses reflection to access the internal Android Keystore interface, this is not recommended to + use android internal interface, will consider to rewrite this component using + Android AccountManager.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        mAndroidKeyStore

        +
        private java.lang.Object mAndroidKeyStore
        +
        • +
      + + + +
        +
      • +

        mContains

        +
        private java.lang.reflect.Method mContains
        +
        • +
      + + + +
        +
      • +

        mDelete

        +
        private java.lang.reflect.Method mDelete
        +
        • +
      + + + +
        +
      • +

        mPut

        +
        private java.lang.reflect.Method mPut
        +
        • +
      + + + +
        +
      • +

        mGet

        +
        private java.lang.reflect.Method mGet
        +
        • +
      + + + +
        +
      • +

        mGetLastError

        +
        private java.lang.reflect.Method mGetLastError
        +
        • +
      + + + +
        +
      • +

        mList

        +
        private java.lang.reflect.Method mList
        +
        • +
      + + + +
        +
      • +

        mState

        +
        private java.lang.reflect.Method mState
        +
        • +
      + + + +
        +
      • +

        mStateEnumConstants

        +
        private java.lang.Object[] mStateEnumConstants
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KeyStoreAdapter

        +
        private KeyStoreAdapter()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyStore

        +
        public static KeyStore getKeyStore()
        +
        • +
      + + + +
        +
      • +

        isUnlocked

        +
        public boolean isUnlocked()
        +
        +
        Specified by:
        +
        isUnlocked in interface KeyStore
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains(java.lang.String key)
        +
        +
        Specified by:
        +
        contains in interface KeyStore
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public boolean delete(java.lang.String key)
        +
        +
        Specified by:
        +
        delete in interface KeyStore
        +
        +
        • +
      + + + +
        +
      • +

        put

        +
        public boolean put(java.lang.String key,
+                   byte[] value)
        +
        +
        Specified by:
        +
        put in interface KeyStore
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public byte[] get(java.lang.String key)
        +
        +
        Specified by:
        +
        get in interface KeyStore
        +
        +
        • +
      + + + +
        +
      • +

        getLastError

        +
        public int getLastError()
        +
        +
        Specified by:
        +
        getLastError in interface KeyStore
        +
        +
        • +
      + + + +
        +
      • +

        saw

        +
        public java.lang.String[] saw(java.lang.String prefix)
        +
        +
        Specified by:
        +
        saw in interface KeyStore
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreException.html new file mode 100644 index 00000000..ebe06862 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreException.html @@ -0,0 +1,274 @@ + + + + + +KeyStoreException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.security
+

Class KeyStoreException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • com.ca.mas.core.security.KeyStoreException
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class KeyStoreException
+extends java.lang.Exception
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      KeyStoreException(java.lang.String message, + java.lang.Throwable cause) 
      KeyStoreException(java.lang.Throwable cause) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KeyStoreException

        +
        public KeyStoreException(java.lang.String message,
+                         java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        KeyStoreException

        +
        public KeyStoreException(java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreKeyStorageProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreKeyStorageProvider.html new file mode 100644 index 00000000..c91fe9a6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreKeyStorageProvider.html @@ -0,0 +1,528 @@ + + + + + +KeyStoreKeyStorageProvider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class KeyStoreKeyStorageProvider

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.security.KeyStoreKeyStorageProvider
      • +
    +
    • +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      KeyStoreKeyStorageProvider(android.content.Context ctx) +
      Default constructor.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private javax.crypto.SecretKeydecryptSecretKey(byte[] encryptedSecretKey) +
      This method decrypts a SecretKey using an RSA key.
      +
      (package private) abstract booleandeleteSecretKeyLocally(java.lang.String alias) +
      Delete the secret key locally.
      +
      private byte[]encryptSecretKey(javax.crypto.SecretKey secretKey) +
      This method encrypts a SecretKey using an RSA key.
      +
      android.content.ContextgetContext() 
      (package private) abstract byte[]getEncryptedSecretKey(java.lang.String alias) 
      javax.crypto.SecretKeygetKey(java.lang.String alias, + boolean userAuthenticationRequired) +
      Retrieve the SecretKey from Storage
      +
      booleanremoveKey(java.lang.String alias) +
      Remove the key
      +
      (package private) abstract booleanstoreSecretKeyLocally(java.lang.String alias, + byte[] encryptedSecretKey) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        VALIDITY_SECONDS

        +
        private static final int VALIDITY_SECONDS
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ASYM_KEY_ALIAS

        +
        private static final java.lang.String ASYM_KEY_ALIAS
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        RSA_ECB_PKCS1_PADDING

        +
        private static final java.lang.String RSA_ECB_PKCS1_PADDING
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        context

        +
        private android.content.Context context
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KeyStoreKeyStorageProvider

        +
        public KeyStoreKeyStorageProvider(@NonNull
+                                  android.content.Context ctx)
        +
        Default constructor.
        +
        +
        Parameters:
        +
        ctx - context
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKey

        +
        public javax.crypto.SecretKey getKey(java.lang.String alias,
+                                     boolean userAuthenticationRequired)
        +
        Retrieve the SecretKey from Storage
        +
        +
        Specified by:
        +
        getKey in interface KeyStorageProvider
        +
        Parameters:
        +
        alias - : The alias to find the Key
        +
        Returns:
        +
        The SecretKey
        +
        +
        • +
      + + + +
        +
      • +

        removeKey

        +
        public boolean removeKey(java.lang.String alias)
        +
        Remove the key
        +
        +
        Specified by:
        +
        removeKey in interface KeyStorageProvider
        +
        Parameters:
        +
        alias - the alias of the key to remove
        +
        +
        • +
      + + + +
        +
      • +

        storeSecretKeyLocally

        +
        abstract boolean storeSecretKeyLocally(java.lang.String alias,
+                                       byte[] encryptedSecretKey)
        +
        +
        Parameters:
        +
        alias - The alias to store the key against.
        +
        encryptedSecretKey - The encrypted secret key to store.
        +
        Returns:
        +
        Success/Fail
        +
        +
        • +
      + + + +
        +
      • +

        getEncryptedSecretKey

        +
        abstract byte[] getEncryptedSecretKey(java.lang.String alias)
        +
        +
        Parameters:
        +
        alias - The alias for the required secret key.
        +
        Returns:
        +
        the encrypted bytes
        +
        +
        • +
      + + + +
        +
      • +

        deleteSecretKeyLocally

        +
        abstract boolean deleteSecretKeyLocally(java.lang.String alias)
        +
        Delete the secret key locally.
        +
        +
        Parameters:
        +
        alias - Alias of the secret key
        +
        Returns:
        +
        success / fail
        +
        +
        • +
      + + + +
        +
      • +

        encryptSecretKey

        +
        private byte[] encryptSecretKey(javax.crypto.SecretKey secretKey)
        +
        This method encrypts a SecretKey using an RSA key. + This is intended for Pre-Android.M, where the + SecretKey cannot be stored in the AndroidKeyStore
        +
        +
        Parameters:
        +
        secretKey - SecretKey to encrypt
        +
        +
        • +
      + + + +
        +
      • +

        decryptSecretKey

        +
        private javax.crypto.SecretKey decryptSecretKey(byte[] encryptedSecretKey)
        +
        This method decrypts a SecretKey using an RSA key. + This is intended for Pre-Android.M, where the + SecretKey cannot be stored in the AndroidKeyStore
        +
        +
        Parameters:
        +
        encryptedSecretKey - the encrypted bytes of the secret key
        +
        +
        • +
      + + + +
        +
      • +

        getContext

        +
        public android.content.Context getContext()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreRepository.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreRepository.html new file mode 100644 index 00000000..3083ed8e --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/KeyStoreRepository.html @@ -0,0 +1,538 @@ + + + + + +KeyStoreRepository + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class KeyStoreRepository

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.security.KeyStoreRepository
      • +
    +
    • +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      KeyStoreRepository() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      abstract java.security.KeyPaircreatePrivateKey(java.lang.String alias, + GenerateKeyAttribute attributes) +
      Create Private key and store to keystore
      +
      abstract voiddeleteCertificateChain(java.lang.String alias) +
      Delete certificate chain from keystore
      +
      abstract voiddeleteKey(java.lang.String alias) +
      Delete Key from keystore
      +
      abstract byte[]generateCertificateSigningRequest(java.lang.String commonName, + java.lang.String deviceId, + java.lang.String deviceName, + java.lang.String organization, + java.security.PrivateKey privateKey, + java.security.PublicKey publicKey) +
      Generate Certificate Signing Request
      +
      abstract java.security.cert.X509Certificate[]getCertificateChain(java.lang.String alias) +
      Retrieve the stored Certificate Chain
      +
      static KeyStoreRepositorygetKeyStoreRepository() 
      abstract java.security.KeygetPrivateKey(java.lang.String alias) +
      Retrieve Private from keystore
      +
      abstract java.security.KeygetPublicKey(java.lang.String alias) +
      Retrieve Public from keystore
      +
      static booleanisPinRequired() 
      abstract voidsaveCertificateChain(java.lang.String alias, + java.security.cert.X509Certificate[] chain) +
      Save certificate chain to keystore
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + + + + + +
        +
      • +

        pinRequired

        +
        private static final boolean pinRequired
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KeyStoreRepository

        +
        public KeyStoreRepository()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPrivateKey

        +
        public abstract java.security.Key getPrivateKey(java.lang.String alias)
+                                         throws KeyStoreException
        +
        Retrieve Private from keystore
        +
        +
        Parameters:
        +
        alias - Private Key Alias
        +
        Returns:
        +
        The Private Key
        +
        Throws:
        +
        KeyStoreException
        +
        +
        • +
      + + + +
        +
      • +

        getPublicKey

        +
        public abstract java.security.Key getPublicKey(java.lang.String alias)
+                                        throws KeyStoreException
        +
        Retrieve Public from keystore
        +
        +
        Parameters:
        +
        alias - Public Key Alias
        +
        Returns:
        +
        The Public Key
        +
        Throws:
        +
        KeyStoreException
        +
        +
        • +
      + + + +
        +
      • +

        deleteKey

        +
        public abstract void deleteKey(java.lang.String alias)
        +
        Delete Key from keystore
        +
        +
        Parameters:
        +
        alias - Key Alias
        +
        +
        • +
      + + + +
        +
      • +

        createPrivateKey

        +
        public abstract java.security.KeyPair createPrivateKey(java.lang.String alias,
+                                                       GenerateKeyAttribute attributes)
+                                                throws KeyStoreException
        +
        Create Private key and store to keystore
        +
        +
        Parameters:
        +
        alias - Alias to store the key pair
        +
        attributes - Attribute to generate the private key
        +
        Returns:
        +
        The KeyPair
        +
        Throws:
        +
        KeyStoreException
        +
        +
        • +
      + + + +
        +
      • +

        saveCertificateChain

        +
        public abstract void saveCertificateChain(java.lang.String alias,
+                                          java.security.cert.X509Certificate[] chain)
+                                   throws KeyStoreException
        +
        Save certificate chain to keystore
        +
        +
        Parameters:
        +
        alias - Alias to store the certificate chain
        +
        chain - The certificate chain.
        +
        Throws:
        +
        KeyStoreException
        +
        +
        • +
      + + + +
        +
      • +

        getCertificateChain

        +
        public abstract java.security.cert.X509Certificate[] getCertificateChain(java.lang.String alias)
+                                                                  throws KeyStoreException
        +
        Retrieve the stored Certificate Chain
        +
        +
        Parameters:
        +
        alias - Alias for the Certificate Chain
        +
        Returns:
        +
        The Certificate Chain stored in the keystore or null if empty
        +
        Throws:
        +
        KeyStoreException
        +
        +
        • +
      + + + +
        +
      • +

        deleteCertificateChain

        +
        public abstract void deleteCertificateChain(java.lang.String alias)
        +
        Delete certificate chain from keystore
        +
        +
        Parameters:
        +
        alias - Alias for the Certificate Chain
        +
        +
        • +
      + + + +
        +
      • +

        generateCertificateSigningRequest

        +
        public abstract byte[] generateCertificateSigningRequest(java.lang.String commonName,
+                                                         java.lang.String deviceId,
+                                                         java.lang.String deviceName,
+                                                         java.lang.String organization,
+                                                         java.security.PrivateKey privateKey,
+                                                         java.security.PublicKey publicKey)
+                                                  throws java.security.cert.CertificateException
        +
        Generate Certificate Signing Request
        +
        +
        Returns:
        +
        The Certificate Signing Request
        +
        Throws:
        +
        java.security.cert.CertificateException
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isPinRequired

        +
        public static boolean isPinRequired()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/LockableEncryptionProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/LockableEncryptionProvider.html new file mode 100644 index 00000000..f73b733f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/LockableEncryptionProvider.html @@ -0,0 +1,395 @@ + + + + + +LockableEncryptionProvider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class LockableEncryptionProvider

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.security.LockableEncryptionProvider
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected android.content.Contextctx 
      private java.lang.StringkeyAlias 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanclear() +
      This does not clear the key, since it is protected
      +
      byte[]decrypt(byte[] encryptedData) +
      Decrypt the given data.
      +
      byte[]encrypt(byte[] data) +
      Encrypts the given data.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        ctx

        +
        protected android.content.Context ctx
        +
        • +
      + + + +
        +
      • +

        keyAlias

        +
        private java.lang.String keyAlias
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LockableEncryptionProvider

        +
        public LockableEncryptionProvider(@NonNull
+                                  android.content.Context ctx)
        +
        • +
      + + + +
        +
      • +

        LockableEncryptionProvider

        +
        public LockableEncryptionProvider(@NonNull
+                                  android.content.Context ctx,
+                                  @NonNull
+                                  java.lang.String keyAlias)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encrypt

        +
        public byte[] encrypt(byte[] data)
        +
        Encrypts the given data.
        +
        +
        Specified by:
        +
        encrypt in interface EncryptionProvider
        +
        Parameters:
        +
        data - the data to encrypt
        +
        Returns:
        +
        encrypted data as byte[]
        +
        +
        • +
      + + + +
        +
      • +

        decrypt

        +
        public byte[] decrypt(byte[] encryptedData)
        +
        Decrypt the given data.
        +
        +
        Specified by:
        +
        decrypt in interface EncryptionProvider
        +
        Parameters:
        +
        encryptedData - data to be decrypted
        +
        Returns:
        +
        byte[] of decrypted data
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public boolean clear()
        +
        This does not clear the key, since it is protected
        +
        +
        Returns:
        +
        true if removed
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/ScreenLockEncryptionProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/ScreenLockEncryptionProvider.html new file mode 100644 index 00000000..b31f3167 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/ScreenLockEncryptionProvider.html @@ -0,0 +1,444 @@ + + + + + +ScreenLockEncryptionProvider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.security
+

Class ScreenLockEncryptionProvider

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.security.ScreenLockEncryptionProvider
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    EncryptionProvider
    +
    +
    +
    +
    public class ScreenLockEncryptionProvider
+extends java.lang.Object
+implements EncryptionProvider
    +
    This class supports key storage. It will require a screen lock, + but the screen lock can change. For Android pre-N, this is + managed entirely by checking KeyguardManager.isDeviceSecure() + to determine if there is still a screen lock. If the screen + lock, pin/swipe/password, is removed entirely, the keys are + deleted. For Android.N, the keys are also protected inside + the AndroidKeyStore requiring a screen lock.
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      byte[]decrypt(byte[] encryptedData) +
      Decrypt the given data.
      +
      protected booleandeviceHasScreenLock() +
      Determine if there is a screen lock
      +
      byte[]encrypt(byte[] data) +
      Encrypts the given data.
      +
      protected javax.crypto.SecretKeygetKey(java.lang.String alias) +
      Retrieve the SecretKey from Storage
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        ctx

        +
        protected android.content.Context ctx
        +
        • +
      + + + +
        +
      • +

        keyAlias

        +
        private java.lang.String keyAlias
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ScreenLockEncryptionProvider

        +
        public ScreenLockEncryptionProvider(@NonNull
+                                    android.content.Context ctx)
        +
        Constructor
        +
        • +
      + + + +
        +
      • +

        ScreenLockEncryptionProvider

        +
        public ScreenLockEncryptionProvider(@NonNull
+                                    android.content.Context ctx,
+                                    KeyStoreKeyStorageProvider keyStorageProvider)
        +
        Constructor for Android Pre-M, allows for setting + KeyStoreKeyStorageProvider
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encrypt

        +
        public byte[] encrypt(byte[] data)
        +
        Encrypts the given data.
        +
        +
        Specified by:
        +
        encrypt in interface EncryptionProvider
        +
        Parameters:
        +
        data - the data to encrypt
        +
        Returns:
        +
        encrypted data as byte[]
        +
        +
        • +
      + + + +
        +
      • +

        decrypt

        +
        public byte[] decrypt(byte[] encryptedData)
        +
        Decrypt the given data.
        +
        +
        Specified by:
        +
        decrypt in interface EncryptionProvider
        +
        Parameters:
        +
        encryptedData - data to be decrypted
        +
        Returns:
        +
        byte[] of decrypted data
        +
        +
        • +
      + + + +
        +
      • +

        getKey

        +
        protected javax.crypto.SecretKey getKey(java.lang.String alias)
        +
        Retrieve the SecretKey from Storage
        +
        +
        Parameters:
        +
        alias - : The alias to find the Key
        +
        Returns:
        +
        The SecretKey
        +
        +
        • +
      + + + +
        +
      • +

        deviceHasScreenLock

        +
        protected boolean deviceHasScreenLock()
        +
        Determine if there is a screen lock
        +
        +
        Returns:
        +
        true if screen lock present
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/SecureLockException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/SecureLockException.html new file mode 100644 index 00000000..38997117 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/SecureLockException.html @@ -0,0 +1,303 @@ + + + + + +SecureLockException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.security
+

Class SecureLockException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • java.lang.RuntimeException
          • +
        • +
            +
          • com.ca.mas.core.security.SecureLockException
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class SecureLockException
+extends java.lang.RuntimeException
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SecureLockException

        +
        public SecureLockException()
        +
        • +
      + + + +
        +
      • +

        SecureLockException

        +
        public SecureLockException(java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        SecureLockException

        +
        public SecureLockException(java.lang.Throwable cause)
        +
        • +
      + + + +
        +
      • +

        SecureLockException

        +
        public SecureLockException(java.lang.String message,
+                           java.lang.Throwable cause)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/package-frame.html new file mode 100644 index 00000000..94978e96 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/package-frame.html @@ -0,0 +1,45 @@ + + + + + +com.ca.mas.core.security + + + + + +

com.ca.mas.core.security

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/package-summary.html new file mode 100644 index 00000000..4809845e --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/package-summary.html @@ -0,0 +1,253 @@ + + + + + +com.ca.mas.core.security + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.security

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/package-tree.html new file mode 100644 index 00000000..21e290c1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/security/package-tree.html @@ -0,0 +1,184 @@ + + + + + +com.ca.mas.core.security Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.security

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/AuthenticationProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/AuthenticationProvider.html new file mode 100644 index 00000000..d305dab4 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/AuthenticationProvider.html @@ -0,0 +1,471 @@ + + + + + +AuthenticationProvider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.service
+

Class AuthenticationProvider

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.service.AuthenticationProvider
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.os.Parcelable
    +
    +
    +
    +
    public class AuthenticationProvider
+extends java.lang.Object
+implements android.os.Parcelable
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface android.os.Parcelable

        +android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringALL 
      static android.os.Parcelable.Creator<AuthenticationProvider>CREATOR 
      static java.lang.StringENTERPRISE 
      (package private) java.lang.Stringidp 
      (package private) java.util.List<Provider>providers 
      +
        +
      • + + +

        Fields inherited from interface android.os.Parcelable

        +CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
        • +
      +
      • +
    + + + + +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AuthenticationProvider

        +
        public AuthenticationProvider(java.lang.String idp,
+                              java.util.List<Provider> providers)
        +
        • +
      + + + +
        +
      • +

        AuthenticationProvider

        +
        protected AuthenticationProvider(android.os.Parcel in)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEnterpriseEnabled

        +
        public boolean isEnterpriseEnabled()
        +
        • +
      + + + +
        +
      • +

        getIdp

        +
        public java.lang.String getIdp()
        +
        • +
      + + + +
        +
      • +

        getProviders

        +
        public java.util.List<Provider> getProviders()
        +
        • +
      + + + +
        +
      • +

        describeContents

        +
        public int describeContents()
        +
        +
        Specified by:
        +
        describeContents in interface android.os.Parcelable
        +
        +
        • +
      + + + +
        +
      • +

        writeToParcel

        +
        public void writeToParcel(android.os.Parcel dest,
+                          int flags)
        +
        +
        Specified by:
        +
        writeToParcel in interface android.os.Parcelable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoClient.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoClient.html new file mode 100644 index 00000000..d2706010 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoClient.html @@ -0,0 +1,483 @@ + + + + + +MssoClient + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.service
+

Class MssoClient

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.service.MssoClient
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MssoClient
+extends java.lang.Object
    +
    Encapsulates use of the MssoService.
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MssoClient(MssoContext mssoContext, + android.content.Context sysContext) +
      Create a service client with the specified MSSO context and system context.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        appContext

        +
        private final android.content.Context appContext
        +
        • +
      + + + +
        +
      • +

        mssoContext

        +
        private final MssoContext mssoContext
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MssoClient

        +
        public MssoClient(MssoContext mssoContext,
+                  android.content.Context sysContext)
        +
        Create a service client with the specified MSSO context and system context.
        +
        +
        Parameters:
        +
        mssoContext - the configured and initialized MSSO context. Required.
        +
        sysContext - the system context to use for invoking the MssoService. Required.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        processRequest

        +
        public long processRequest(MASRequest request,
+                           android.os.ResultReceiver resultReceiver)
        +
        Submit a request to be processed. +

        + The response to the request will be delivered to the specified result receiver.

        +
        +
        Parameters:
        +
        request - the request to send. Required.
        +
        resultReceiver - the resultReceiver to notify when a response is available, or if there is an error. Required.
        +
        Returns:
        +
        the request ID, which can be used to pick up the response once it is available.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        authenticate

        +
        public void authenticate(MASAuthCredentials credentials,
+                         MAGResultReceiver resultReceiver)
        +

        Logs in a user with MASAuthCredentials. +

        The response to the request will eventually be delivered to the specified result receiver.

        +

        This method returns immediately to the calling thread

        +
        +
        Parameters:
        +
        credentials - The credentials to log in with
        +
        resultReceiver - The resultReceiver to notify when a response is available, or if there is an error. Required.
        +
        +
        • +
      + + + +
        +
      • +

        processPendingRequests

        +
        public void processPendingRequests()
        +
        Submit a wakeup message to the intent service, ensuring that any enqueued requests are being processed.
        +
        • +
      + + + +
        +
      • +

        takeMAGResponse

        +
        public static MASResponse takeMAGResponse(long requestId)
        +
        Collect a response to the specified request ID, if one is available. +

        + This can be called after the result receiver is notified about the response. +

        + Once a response has been picked up, it is removed from the queue and cannot be picked up a second time.

        +
        +
        Parameters:
        +
        requestId - the request ID whose response to pick up.
        +
        Returns:
        +
        the response, or null if one is not available at this time.
        +
        +
        • +
      + + + +
        +
      • +

        cancelRequest

        +
        public void cancelRequest(long requestId,
+                          android.os.Bundle data)
        +
        Cancel the specified request ID. If the response notification has not already been delivered (or is not already in progress) + by the time this method executes, a response notification will never occur for the specified request ID.
        +
        +
        Parameters:
        +
        requestId - the request ID to cancel.
        +
        +
        • +
      + + + +
        +
      • +

        cancelAll

        +
        public void cancelAll(android.os.Bundle data)
        +
        Canceling any pending requests and responses that were created by this MssoClient.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoIntents.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoIntents.html new file mode 100644 index 00000000..8e1a3c07 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoIntents.html @@ -0,0 +1,462 @@ + + + + + +MssoIntents + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.ca.mas.core.service
+

Interface MssoIntents

+
+
+
+
    +
  • +
    +
    +
    public interface MssoIntents
    +

    Holds constants related to intents used by the MSSO service.

    +

    If implementing a custom login dialog activity, you will need to start the login activity in response + to an OBTAIN_CREDENTIALS intent. When credentials are obtained you should startService with the CREDENTIALS_OBTAINED + intent. If the activity is canceled (including via the back button), you should startService with the CANCEL_REQUEST + intent. Response intents must include the EXTRA_REQUEST_ID long value copied from the OBTAIN_CREDENTIALS intent.

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringACTION_CREDENTIALS_OBTAINED +
      An Intent with this action is used by a logon activity to send logon information back to the MssoService.
      +
      static java.lang.StringACTION_PROCESS_REQUEST +
      An Intent with this action triggers processing (or reprocessing) of a request expected to be already present in the MssoRequestQueue.
      +
      static java.lang.StringEXTRA_ADDITIONAL_HEADERS 
      static java.lang.StringEXTRA_AUTH_PROVIDERS +
      The authentication provider.
      +
      static java.lang.StringEXTRA_CREDENTIALS +
      The user credentials being provided with CREDENTIALS_OBTAINED.
      +
      static java.lang.StringEXTRA_OTP_HANDLER +
      The otp authentication otp handler.
      +
      static java.lang.StringEXTRA_REQUEST_ID +
      The ID of the request to (re)process, or -1 to process all pending queued requests that are not currently being processed.
      +
      static intRESULT_CODE_ERR +
      Result code indicating the a response could not be obtained due to an I/O error.
      +
      static intRESULT_CODE_ERR_CANCELED +
      Result code indicating that a request was canceled, perhaps by the user canceling a log on dialog.
      +
      static intRESULT_CODE_SUCCESS +
      Result code indicating an HTTP request was delivered to the target server and a response was received (though the HTTP-level response code may be other than 200).
      +
      static java.lang.StringRESULT_ERROR +
      An error object related to a result code other than RESULT_CODE_SUCCESS.
      +
      static java.lang.StringRESULT_ERROR_MESSAGE +
      An error message related to a result code other than RESULT_CODE_SUCCESS.
      +
      static java.lang.StringRESULT_REQUEST_ID +
      The ID of the request, for picking up the result from the MssoResponseQueue.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ACTION_PROCESS_REQUEST

        +
        static final java.lang.String ACTION_PROCESS_REQUEST
        +
        An Intent with this action triggers processing (or reprocessing) of a request expected to be already present in the MssoRequestQueue. Fired by MssoClient. Handled by MssoService.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ACTION_CREDENTIALS_OBTAINED

        +
        static final java.lang.String ACTION_CREDENTIALS_OBTAINED
        +
        An Intent with this action is used by a logon activity to send logon information back to the MssoService. Fired by logon dialog activity. Handled by MssoService.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        EXTRA_REQUEST_ID

        +
        static final java.lang.String EXTRA_REQUEST_ID
        +
        The ID of the request to (re)process, or -1 to process all pending queued requests that are not currently being processed.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        EXTRA_CREDENTIALS

        +
        static final java.lang.String EXTRA_CREDENTIALS
        +
        The user credentials being provided with CREDENTIALS_OBTAINED.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        EXTRA_ADDITIONAL_HEADERS

        +
        static final java.lang.String EXTRA_ADDITIONAL_HEADERS
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        EXTRA_OTP_HANDLER

        +
        static final java.lang.String EXTRA_OTP_HANDLER
        +
        The otp authentication otp handler.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        EXTRA_AUTH_PROVIDERS

        +
        static final java.lang.String EXTRA_AUTH_PROVIDERS
        +
        The authentication provider.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        RESULT_CODE_SUCCESS

        +
        static final int RESULT_CODE_SUCCESS
        +
        Result code indicating an HTTP request was delivered to the target server and a response was received (though the HTTP-level response code may be other than 200).
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        RESULT_CODE_ERR

        +
        static final int RESULT_CODE_ERR
        +
        Result code indicating the a response could not be obtained due to an I/O error.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        RESULT_CODE_ERR_CANCELED

        +
        static final int RESULT_CODE_ERR_CANCELED
        +
        Result code indicating that a request was canceled, perhaps by the user canceling a log on dialog.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        RESULT_REQUEST_ID

        +
        static final java.lang.String RESULT_REQUEST_ID
        +
        The ID of the request, for picking up the result from the MssoResponseQueue. May be missing if the request was missing a requestId.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        RESULT_ERROR_MESSAGE

        +
        static final java.lang.String RESULT_ERROR_MESSAGE
        +
        An error message related to a result code other than RESULT_CODE_SUCCESS.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        RESULT_ERROR

        +
        static final java.lang.String RESULT_ERROR
        +
        An error object related to a result code other than RESULT_CODE_SUCCESS.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoService.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoService.html new file mode 100644 index 00000000..1c505215 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoService.html @@ -0,0 +1,523 @@ + + + + + +MssoService + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.service
+

Class MssoService

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • android.content.Context
      • +
    • +
        +
      • android.content.ContextWrapper
        • +
      • +
          +
        • android.app.Service
          • +
        • +
            +
          • android.app.IntentService
            • +
          • +
              +
            • com.ca.mas.core.service.MssoService
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.content.ComponentCallbacks, android.content.ComponentCallbacks2
    +
    +
    +
    +
    public class MssoService
+extends android.app.IntentService
    +
    An IntentService that receives outbound HTTP requests encoded into Intents and returns the eventual responses + via a ResultReceiver.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class android.app.Service

        +START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY, STOP_FOREGROUND_DETACH, STOP_FOREGROUND_REMOVE
        • +
      +
        +
      • + + +

        Fields inherited from class android.content.Context

        +ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_EXTERNAL_SERVICE, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, COMPANION_DEVICE_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, FINGERPRINT_SERVICE, HARDWARE_PROPERTIES_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_NO_LOCALIZED_COLLATORS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RECEIVER_VISIBLE_TO_INSTANT_APPS, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, SHORTCUT_SERVICE, STORAGE_SERVICE, STORAGE_STATS_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_CLASSIFICATION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_AWARE_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE
        • +
      +
        +
      • + + +

        Fields inherited from interface android.content.ComponentCallbacks2

        +TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MssoService() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private MssoResponsecreateMssoResponse(MssoRequest request, + MASResponse response) 
      private voidhandleErrorResponse(MssoRequest request, + java.lang.Exception e) 
      private booleanhandleInterceptors(long requestId, + MASRequest request, + android.os.Bundle requestExtra, + MASResponse response) 
      private voidonCredentialsObtained(android.os.Bundle extras, + MssoRequest request) 
      protected voidonHandleIntent(android.content.Intent intent) 
      private voidonProcessAllPendingRequests() 
      private voidonProcessRequest(MssoRequest request) 
      private booleanrequestFinished(MssoRequest request) 
      private voidrespondError(android.os.ResultReceiver receiver, + MAGError error) 
      private voidrespondSuccess(android.os.ResultReceiver receiver, + long requestId, + java.lang.String errorMessage) 
      private voidstartThreadedRequest(android.os.Bundle extras, + MssoRequest request) 
      private MssoRequesttakeActiveRequest(long requestId) 
      +
        +
      • + + +

        Methods inherited from class android.app.IntentService

        +onBind, onCreate, onDestroy, onStart, onStartCommand, setIntentRedelivery
        • +
      +
        +
      • + + +

        Methods inherited from class android.app.Service

        +dump, getApplication, onConfigurationChanged, onLowMemory, onRebind, onTaskRemoved, onTrimMemory, onUnbind, startForeground, stopForeground, stopForeground, stopSelf, stopSelf, stopSelfResult
        • +
      +
        +
      • + + +

        Methods inherited from class android.content.ContextWrapper

        +attachBaseContext, bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createContextForSplit, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDataDir, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getSystemServiceName, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startForegroundService, startInstrumentation, startIntentSender, startIntentSender, startService, stopService, unbindService, unregisterReceiver
        • +
      +
        +
      • + + +

        Methods inherited from class android.content.Context

        +getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MssoService

        +
        public MssoService()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onHandleIntent

        +
        protected void onHandleIntent(android.content.Intent intent)
        +
        +
        Specified by:
        +
        onHandleIntent in class android.app.IntentService
        +
        +
        • +
      + + + +
        +
      • +

        startThreadedRequest

        +
        private void startThreadedRequest(android.os.Bundle extras,
+                                  MssoRequest request)
        +
        • +
      + + + +
        +
      • +

        onCredentialsObtained

        +
        private void onCredentialsObtained(android.os.Bundle extras,
+                                   MssoRequest request)
        +
        • +
      + + + +
        +
      • +

        onProcessAllPendingRequests

        +
        private void onProcessAllPendingRequests()
        +
        • +
      + + + +
        +
      • +

        onProcessRequest

        +
        private void onProcessRequest(MssoRequest request)
        +
        • +
      + + + +
        +
      • +

        handleErrorResponse

        +
        private void handleErrorResponse(MssoRequest request,
+                                 java.lang.Exception e)
        +
        • +
      + + + +
        +
      • +

        handleInterceptors

        +
        private boolean handleInterceptors(long requestId,
+                                   MASRequest request,
+                                   android.os.Bundle requestExtra,
+                                   MASResponse response)
        +
        +
        Returns:
        +
        True to keep the request message to the queue
        +
        +
        • +
      + + + + + + + +
        +
      • +

        takeActiveRequest

        +
        private MssoRequest takeActiveRequest(long requestId)
        +
        • +
      + + + +
        +
      • +

        requestFinished

        +
        private boolean requestFinished(MssoRequest request)
        +
        • +
      + + + +
        +
      • +

        respondError

        +
        private void respondError(android.os.ResultReceiver receiver,
+                          MAGError error)
        +
        • +
      + + + +
        +
      • +

        respondSuccess

        +
        private void respondSuccess(android.os.ResultReceiver receiver,
+                            long requestId,
+                            java.lang.String errorMessage)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoState.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoState.html new file mode 100644 index 00000000..1af6997d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/MssoState.html @@ -0,0 +1,319 @@ + + + + + +MssoState + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.service
+

Class MssoState

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.service.MssoState
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class MssoState
+extends java.lang.Object
    +
    Holds flag variables indicating various things.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static java.util.concurrent.atomic.AtomicBooleanexpectingUnlock 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MssoState() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      (package private) static booleanisExpectedUnlock() 
      (package private) static voidsetExpectingUnlock(boolean b) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        expectingUnlock

        +
        private static final java.util.concurrent.atomic.AtomicBoolean expectingUnlock
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MssoState

        +
        public MssoState()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isExpectedUnlock

        +
        static boolean isExpectedUnlock()
        +
        • +
      + + + +
        +
      • +

        setExpectingUnlock

        +
        static void setExpectingUnlock(boolean b)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/Provider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/Provider.html new file mode 100644 index 00000000..5e9215b1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/Provider.html @@ -0,0 +1,480 @@ + + + + + +Provider + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.service
+

Class Provider

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.service.Provider
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.os.Parcelable
    +
    +
    +
    +
    public class Provider
+extends java.lang.Object
+implements android.os.Parcelable
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface android.os.Parcelable

        +android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static android.os.Parcelable.Creator<Provider>CREATOR 
      private java.lang.IntegericonId 
      private java.lang.Stringid 
      private java.lang.StringpollUrl 
      private java.lang.Stringurl 
      +
        +
      • + + +

        Fields inherited from interface android.os.Parcelable

        +CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected Provider(android.os.Parcel in) 
       Provider(java.lang.String id, + java.lang.String url, + java.lang.String pollUrl, + java.lang.Integer iconId) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intdescribeContents() 
      java.lang.IntegergetIconId() 
      java.lang.StringgetId() 
      java.lang.StringgetPollUrl() 
      java.lang.StringgetUrl() 
      voidwriteToParcel(android.os.Parcel dest, + int flags) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        id

        +
        private java.lang.String id
        +
        • +
      + + + +
        +
      • +

        url

        +
        private java.lang.String url
        +
        • +
      + + + +
        +
      • +

        pollUrl

        +
        private java.lang.String pollUrl
        +
        • +
      + + + +
        +
      • +

        iconId

        +
        private java.lang.Integer iconId
        +
        • +
      + + + +
        +
      • +

        CREATOR

        +
        public static final android.os.Parcelable.Creator<Provider> CREATOR
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Provider

        +
        public Provider(java.lang.String id,
+                java.lang.String url,
+                java.lang.String pollUrl,
+                java.lang.Integer iconId)
        +
        • +
      + + + +
        +
      • +

        Provider

        +
        protected Provider(android.os.Parcel in)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getId

        +
        public java.lang.String getId()
        +
        • +
      + + + +
        +
      • +

        getPollUrl

        +
        public java.lang.String getPollUrl()
        +
        • +
      + + + +
        +
      • +

        getUrl

        +
        public java.lang.String getUrl()
        +
        • +
      + + + +
        +
      • +

        getIconId

        +
        public java.lang.Integer getIconId()
        +
        • +
      + + + +
        +
      • +

        describeContents

        +
        public int describeContents()
        +
        +
        Specified by:
        +
        describeContents in interface android.os.Parcelable
        +
        +
        • +
      + + + +
        +
      • +

        writeToParcel

        +
        public void writeToParcel(android.os.Parcel dest,
+                          int flags)
        +
        +
        Specified by:
        +
        writeToParcel in interface android.os.Parcelable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/package-frame.html new file mode 100644 index 00000000..c9e518e4 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/package-frame.html @@ -0,0 +1,35 @@ + + + + + +com.ca.mas.core.service + + + + + +

com.ca.mas.core.service

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/package-summary.html new file mode 100644 index 00000000..d91f98f1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/package-summary.html @@ -0,0 +1,220 @@ + + + + + +com.ca.mas.core.service + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.service

+
+
+
    +
  • + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    MssoIntents +
    Holds constants related to intents used by the MSSO service.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    AuthenticationProvider 
    MssoActiveQueue +
    Represents pending active requests.
    +
    MssoClient +
    Encapsulates use of the MssoService.
    +
    MssoClient.MssoClientAuthenticateAsyncTask 
    MssoExecutorService +
    An executor service to manage the thread launching mechanism for MssoService.
    +
    MssoRequest +
    Holds information about an MSSO request while it is waiting to be processed.
    +
    MssoRequestQueue +
    Represents pending outbound requests.
    +
    MssoResponse +
    Holds information about a response to an MSSO request that is awaiting pickup.
    +
    MssoResponseQueue +
    Represents completed responses awaiting pickup.
    +
    MssoService +
    An IntentService that receives outbound HTTP requests encoded into Intents and returns the eventual responses + via a ResultReceiver.
    +
    MssoState +
    Holds flag variables indicating various things.
    +
    Provider 
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/package-tree.html new file mode 100644 index 00000000..bdeb5e7a --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/service/package-tree.html @@ -0,0 +1,170 @@ + + + + + +com.ca.mas.core.service Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.service

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/Storage.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/Storage.html new file mode 100644 index 00000000..05413df0 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/Storage.html @@ -0,0 +1,1055 @@ + + + + + +Storage + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.storage
+

Class Storage

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.storage.Storage
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    AccountManagerStorage, KeyStoreStorage
    +
    +
    +
    +
    public abstract class Storage
+extends java.lang.Object
    +
    Storage interfaces to support CRUD operations. +

    +

    + The implementation(s) should extend this abstract class and override the required methods. They + should notify the caller about the operation status via the + StorageResult, when ever possible. +

    + The interface has methods that +

    + a) Returns a value: These are generally meant for Synchronous operations. Implementations should + throw an StorageException with code StorageException.UNSUPPORTED_OPERATION + if the storage cannot be accessed in a Synchronous/Atomic way, so that a value can be returned. +

    + b) Does not return a value: These are meant for Asynchronous operations. The caller should be + notified about the operation status via the callback parameter that is passed in. Also these + methods could throw Exceptions, in case of some input validations. +

    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Storage

        +
        protected Storage(java.lang.Object options)
+           throws StorageException
        +
        Initialize the storage.
        +
        +
        Parameters:
        +
        options - Input to set up the storage
        +
        Throws:
        +
        StorageException - if initialization of storage fails.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        writeData

        +
        public abstract StorageResult writeData(java.lang.String key,
+                                        byte[] value)
+                                 throws StorageException
        +
        Writes some generic data to the Storage. The operation will fail if there is any previous + data associated with the key. This method is expected to block and hence its recommended to + call this method from a non-UI thread.
        +
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The generic data that needs to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeData

        +
        public abstract void writeData(java.lang.String key,
+                               byte[] value,
+                               StorageResultReceiver callback)
+                        throws StorageException
        +
        Writes some generic data to the Storage. The operation will fail if there is any previous + data associated with the key. Implementations are requested to offload all heavy duty work to + another thread and use the callback to notify the caller.
        +
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The generic data that needs to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeString

        +
        public abstract StorageResult writeString(java.lang.String key,
+                                          java.lang.String value)
+                                   throws StorageException
        +
        Writes String data to the Storage. This is a convenience method and will generally use other + flavours of writeData to complete the operation. The operation will fail if there is any + previous data associated with the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The String data that need to be stored
        +
        Returns:
        +
        StorageResult ,which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeString

        +
        public abstract void writeString(java.lang.String key,
+                                 java.lang.String value,
+                                 StorageResultReceiver callback)
+                          throws StorageException
        +
        Writes String data to the Storage. This is a convenience method and will generally use other + flavours of writeData to complete the operation. The operation will fail if there is any + previous data associated with the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The String data that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readData

        +
        public abstract StorageResult readData(java.lang.String key)
+                                throws StorageException
        +
        Fetches generic data from the Store. The operation will fail if there is no + previous data associated with the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        Returns:
        +
        StorageResult ,which is expected to have + - the requested data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readData

        +
        public abstract void readData(java.lang.String key,
+                              StorageResultReceiver callback)
+                       throws StorageException
        +
        Fetches generic data from the Store. The operation will fail if there is no + previous data associated with the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        callback - send a StorageResult, which is expected to have + - the requested data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readString

        +
        public abstract StorageResult readString(java.lang.String key)
+                                  throws StorageException
        +
        Fetches String data from the Store. The operation will fail if there is no + previous data associated with the key.This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Parameters:
        +
        key - The key for which the String data has to be retrieved
        +
        Returns:
        +
        StorageResult ,which is expected to have + - the String data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readString

        +
        public abstract void readString(java.lang.String key,
+                                StorageResultReceiver callback)
+                         throws StorageException
        +
        Fetches String from the Store. The operation will fail if there is no + previous data associated with the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Parameters:
        +
        key - The key for which the String data has to be retrieved
        +
        callback - send a StorageResult, which is expected to have + - the requested data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        updateData

        +
        public abstract StorageResult updateData(java.lang.String key,
+                                         byte[] value)
+                                  throws StorageException
        +
        Updates a pre-existing data with a new one. This operation will only update, if the data + already exists for the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        updateData

        +
        public abstract void updateData(java.lang.String key,
+                                byte[] value,
+                                StorageResultReceiver callback)
+                         throws StorageException
        +
        Updates a pre-existing data with a new one. This operation will only update, if the data + already exists for the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        updateString

        +
        public abstract StorageResult updateString(java.lang.String key,
+                                           java.lang.String value)
+                                    throws StorageException
        +
        Updates a pre-existing data with a new String. This operation will only update, if the data + already exists for the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        updateString

        +
        public abstract void updateString(java.lang.String key,
+                                  java.lang.String value,
+                                  StorageResultReceiver callback)
+                           throws StorageException
        +
        Updates a pre-existing data with a new String. This operation will only update, if the data + already exists for the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateData

        +
        public abstract StorageResult writeOrUpdateData(java.lang.String key,
+                                                byte[] value)
+                                         throws StorageException
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. This method is expected to + block and hence its recommended to call this method from a non-UI thread.
        +
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateData

        +
        public abstract void writeOrUpdateData(java.lang.String key,
+                                       byte[] value,
+                                       StorageResultReceiver callback)
+                                throws StorageException
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. Implementations are requested + to offload all heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateString

        +
        public abstract StorageResult writeOrUpdateString(java.lang.String key,
+                                                  java.lang.String value)
+                                           throws StorageException
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. This method is expected to + block and hence its recommended to call this method from a non-UI thread.
        +
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateString

        +
        public abstract void writeOrUpdateString(java.lang.String key,
+                                         java.lang.String value,
+                                         StorageResultReceiver callback)
+                                  throws StorageException
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. Implementations are requested + to offload all heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        deleteData

        +
        public abstract StorageResult deleteData(java.lang.String key)
+                                  throws StorageException
        +
        Deletes an entry, essentially a key-value pair, from the storage. This method is expected to + block and hence its recommended to call this method from a non-UI thread.
        +
        +
        Parameters:
        +
        key - The key for which the data will be deleted
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + + + + + +
        +
      • +

        deleteData

        +
        public abstract void deleteData(java.lang.String key,
+                                StorageResultReceiver callback)
+                         throws StorageException
        +
        Deletes an entry, essentially a key-value pair, from the storage. Implementations are + requested to offload all heavy duty work to another thread and use the callback to + notify the caller.
        +
        +
        Parameters:
        +
        key - The key for which the data will be deleted
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        deleteAll

        +
        public abstract StorageResult deleteAll()
        +
        Deletes all entries from the storage. This method is expected to block and hence + its recommended to call this method from a non-UI thread.
        +
        +
        Returns:
        +
        StorageResult which is expected to have + - status part to be SUCCESS, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public abstract void deleteAll(StorageResultReceiver callback)
+                        throws StorageException
        +
        Deletes all entries from the storage. Implementations are requested to offload all heavy + duty work to another thread and use the callback to notify the caller.
        +
        +
        Parameters:
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - status part to be SUCCESS, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        getAllKeys

        +
        public abstract StorageResult getAllKeys()
        +
        Fetch all the keys against which data are stored. This method is expected to block and hence + its recommended to call this method from a non-UI thread.
        +
        +
        Returns:
        +
        An StorageResult , which is expected to have + - a list of all the keys (or an empty list) as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        +
        • +
      + + + +
        +
      • +

        getAllKeys

        +
        public abstract void getAllKeys(StorageResultReceiver callback)
+                         throws StorageException
        +
        Fetch all the keys against which data are stored. Implementations are requested to offload + all heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Parameters:
        +
        callback - send a StorageResult , which is expected to have + - a list of all the keys (or an empty list) as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageException.html new file mode 100644 index 00000000..6a286c99 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageException.html @@ -0,0 +1,760 @@ + + + + + +StorageException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.storage
+

Class StorageException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • com.ca.mas.core.storage.StorageException
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.os.Parcelable, java.io.Serializable
    +
    +
    +
    +
    public class StorageException
+extends java.lang.Exception
+implements android.os.Parcelable
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        CREATOR

        +
        public static final android.os.Parcelable.Creator CREATOR
        +
        • +
      + + + + + + + +
        +
      • +

        INVALID_INPUT_KEY

        +
        public static final int INVALID_INPUT_KEY
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        INVALID_INPUT_VALUE

        +
        public static final int INVALID_INPUT_VALUE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        INVALID_INPUT_CALLBACK

        +
        public static final int INVALID_INPUT_CALLBACK
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        WRITE_DATA_ALREADY_EXISTS

        +
        public static final int WRITE_DATA_ALREADY_EXISTS
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        READ_DATA_NOT_FOUND

        +
        public static final int READ_DATA_NOT_FOUND
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        INSTANTIATION_ERROR

        +
        public static final int INSTANTIATION_ERROR
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        UNSUPPORTED_DATA

        +
        public static final int UNSUPPORTED_DATA
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        OPERATION_FAILED

        +
        public static final int OPERATION_FAILED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + +
        +
      • +

        UNSUPPORTED_OPERATION

        +
        public static final int UNSUPPORTED_OPERATION
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        KEY_SIZE_LIMIT_EXCEEDED

        +
        public static final int KEY_SIZE_LIMIT_EXCEEDED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DATA_SIZE_LIMIT_EXCEEDED

        +
        public static final int DATA_SIZE_LIMIT_EXCEEDED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        INSTANTIATION_ERROR_UNAUTHORIZED

        +
        public static final int INSTANTIATION_ERROR_UNAUTHORIZED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        KEYSTORE_KEY_SIZE_LIMIT_EXCEEDED

        +
        public static final int KEYSTORE_KEY_SIZE_LIMIT_EXCEEDED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        KEYSTORE_DATA_SIZE_LIMIT_EXCEEDED

        +
        public static final int KEYSTORE_DATA_SIZE_LIMIT_EXCEEDED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        STORE_NOT_UNLOCKED

        +
        public static final int STORE_NOT_UNLOCKED
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        code

        +
        private int code
        +
        The code that is associated with this instance
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorageException

        +
        public StorageException(int code)
        +
        • +
      + + + +
        +
      • +

        StorageException

        +
        public StorageException(java.lang.String detailMessage,
+                        java.lang.Throwable throwable,
+                        int code)
        +
        • +
      + + + +
        +
      • +

        StorageException

        +
        private StorageException(android.os.Parcel input)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCode

        +
        public int getCode()
        +
        • +
      + + + +
        +
      • +

        describeContents

        +
        public int describeContents()
        +
        +
        Specified by:
        +
        describeContents in interface android.os.Parcelable
        +
        +
        • +
      + + + +
        +
      • +

        writeToParcel

        +
        public void writeToParcel(android.os.Parcel destination,
+                          int flags)
        +
        +
        Specified by:
        +
        writeToParcel in interface android.os.Parcelable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResult.StorageOperationStatus.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResult.StorageOperationStatus.html new file mode 100644 index 00000000..002804f9 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResult.StorageOperationStatus.html @@ -0,0 +1,379 @@ + + + + + +StorageResult.StorageOperationStatus + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.storage
+

Enum StorageResult.StorageOperationStatus

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      FAILURE 
      SUCCESS 
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private intvalue 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static StorageResult.StorageOperationStatusvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static StorageResult.StorageOperationStatus[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        value

        +
        private int value
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static StorageResult.StorageOperationStatus[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (StorageResult.StorageOperationStatus c : StorageResult.StorageOperationStatus.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static StorageResult.StorageOperationStatus valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResult.StorageOperationType.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResult.StorageOperationType.html new file mode 100644 index 00000000..c40c8ed6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResult.StorageOperationType.html @@ -0,0 +1,499 @@ + + + + + +StorageResult.StorageOperationType + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.storage
+

Enum StorageResult.StorageOperationType

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResult.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResult.html new file mode 100644 index 00000000..f0248884 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResult.html @@ -0,0 +1,517 @@ + + + + + +StorageResult + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.storage
+

Class StorageResult

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.storage.StorageResult
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.os.Parcelable
    +
    +
    +
    +
    public class StorageResult
+extends java.lang.Object
+implements android.os.Parcelable
    +
    This is the data transfer object that gets passed to the caller as either the return value + or via the callback. +

    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResultReceiver.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResultReceiver.html new file mode 100644 index 00000000..de892efe --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/StorageResultReceiver.html @@ -0,0 +1,336 @@ + + + + + +StorageResultReceiver + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.storage
+

Class StorageResultReceiver

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.ca.mas.core.storage.StorageResultReceiver
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class StorageResultReceiver
+extends java.lang.Object
    +
    Callback object that is used as a transport for the StorageResult, especially for an + Async operation. This is essentially a wrapper around @{link ResultReceiver} +

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private android.os.ResultReceiverreceiver 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StorageResultReceiver(android.os.Handler handler) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidonReceiveResult(StorageResult result) +
      Override to receive results delivered to this object
      +
      voidsend(StorageResult result) +
      Deliver a result to this receiver.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        receiver

        +
        private final android.os.ResultReceiver receiver
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorageResultReceiver

        +
        public StorageResultReceiver(android.os.Handler handler)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        send

        +
        public final void send(StorageResult result)
        +
        Deliver a result to this receiver. Will send @{link #onReceiveResult} asynchronously if the receiver + has supplied a Handler in which to dispatch the result.
        +
        +
        Parameters:
        +
        result - The @{link StorageResult} to onReceiveResult to the caller.
        +
        +
        • +
      + + + +
        +
      • +

        onReceiveResult

        +
        public void onReceiveResult(StorageResult result)
        +
        Override to receive results delivered to this object
        +
        +
        Parameters:
        +
        result - The @{link StorageResult} holding the operation result
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/AMSAuthenticatorService.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/AMSAuthenticatorService.html new file mode 100644 index 00000000..21135b7d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/AMSAuthenticatorService.html @@ -0,0 +1,365 @@ + + + + + +AMSAuthenticatorService + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.storage.implementation
+

Class AMSAuthenticatorService

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • android.content.Context
      • +
    • +
        +
      • android.content.ContextWrapper
        • +
      • +
          +
        • android.app.Service
          • +
        • +
            +
          • com.ca.mas.core.storage.implementation.AMSAuthenticatorService
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.content.ComponentCallbacks, android.content.ComponentCallbacks2
    +
    +
    +
    +
    public class AMSAuthenticatorService
+extends android.app.Service
    +
    The service that the application has to refer in its Manifest. The service is basically a + wrapper to the underlying Authenticator implementation.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      private class AMSAuthenticatorService.AccountAuthenticator +
      Empty Authenticator implementation, as our main goal here is storage.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class android.app.Service

        +START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY, STOP_FOREGROUND_DETACH, STOP_FOREGROUND_REMOVE
        • +
      +
        +
      • + + +

        Fields inherited from class android.content.Context

        +ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_EXTERNAL_SERVICE, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, COMPANION_DEVICE_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, FINGERPRINT_SERVICE, HARDWARE_PROPERTIES_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_NO_LOCALIZED_COLLATORS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RECEIVER_VISIBLE_TO_INSTANT_APPS, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, SHORTCUT_SERVICE, STORAGE_SERVICE, STORAGE_STATS_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_CLASSIFICATION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_AWARE_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE
        • +
      +
        +
      • + + +

        Fields inherited from interface android.content.ComponentCallbacks2

        +TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      android.os.IBinderonBind(android.content.Intent intent) 
      +
        +
      • + + +

        Methods inherited from class android.app.Service

        +dump, getApplication, onConfigurationChanged, onCreate, onDestroy, onLowMemory, onRebind, onStart, onStartCommand, onTaskRemoved, onTrimMemory, onUnbind, startForeground, stopForeground, stopForeground, stopSelf, stopSelf, stopSelfResult
        • +
      +
        +
      • + + +

        Methods inherited from class android.content.ContextWrapper

        +attachBaseContext, bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createContextForSplit, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDataDir, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getSystemServiceName, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startForegroundService, startInstrumentation, startIntentSender, startIntentSender, startService, stopService, unbindService, unregisterReceiver
        • +
      +
        +
      • + + +

        Methods inherited from class android.content.Context

        +getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AMSAuthenticatorService

        +
        public AMSAuthenticatorService()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onBind

        +
        public android.os.IBinder onBind(android.content.Intent intent)
        +
        +
        Specified by:
        +
        onBind in class android.app.Service
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/AccountManagerStorage.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/AccountManagerStorage.html new file mode 100644 index 00000000..28412443 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/AccountManagerStorage.html @@ -0,0 +1,1420 @@ + + + + + +AccountManagerStorage + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.storage.implementation
+

Class AccountManagerStorage

+
+
+ +
+
    +
  • +
    +
    +
    public class AccountManagerStorage
+extends Storage
    +
    Android Account based storage implementation. This leverages the AccountManager + to store key value pairs in the Android Accounts Database (inside the "extras" table).
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        SQLITE_MAX_LENGTH

        +
        private static final int SQLITE_MAX_LENGTH
        +
        Limits for key/value
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        KEYINDEX_COLUMN_NAME

        +
        private static final java.lang.String KEYINDEX_COLUMN_NAME
        +
        Column name for the key-index
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        mPrefix

        +
        private java.lang.String mPrefix
        +
        Key Prefix. The value will be the package name for private mode and + "SHARED_" for shared mode
        +
        • +
      + + + +
        +
      • +

        mContext

        +
        private android.content.Context mContext
        +
        The application context
        +
        • +
      + + + + + + + +
        +
      • +

        accountManager

        +
        private AMSSManager accountManager
        +
        AMS Manager
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AccountManagerStorage

        +
        protected AccountManagerStorage(java.lang.Object options)
+                         throws StorageException
        +
        Initialize the storage.
        +
        +
        Parameters:
        +
        options - Array of Objects + First object: Context + (Optional) Second: boolean value indicating shared or private space
        +
        Throws:
        +
        StorageException - if any of the mandatory inputs are invalid/null + or if the initialization of storage fails.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        writeData

        +
        public StorageResult writeData(java.lang.String key,
+                               byte[] value)
+                        throws StorageException
        +
        Description copied from class: Storage
        +
        Writes some generic data to the Storage. The operation will fail if there is any previous + data associated with the key. This method is expected to block and hence its recommended to + call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        writeData in class Storage
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The generic data that needs to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeData

        +
        public void writeData(java.lang.String key,
+                      byte[] value,
+                      StorageResultReceiver callback)
+               throws StorageException
        +
        Description copied from class: Storage
        +
        Writes some generic data to the Storage. The operation will fail if there is any previous + data associated with the key. Implementations are requested to offload all heavy duty work to + another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        writeData in class Storage
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The generic data that needs to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeString

        +
        public StorageResult writeString(java.lang.String key,
+                                 java.lang.String value)
+                          throws StorageException
        +
        Description copied from class: Storage
        +
        Writes String data to the Storage. This is a convenience method and will generally use other + flavours of writeData to complete the operation. The operation will fail if there is any + previous data associated with the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        writeString in class Storage
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The String data that need to be stored
        +
        Returns:
        +
        StorageResult ,which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeString

        +
        public void writeString(java.lang.String key,
+                        java.lang.String value,
+                        StorageResultReceiver callback)
+                 throws StorageException
        +
        Description copied from class: Storage
        +
        Writes String data to the Storage. This is a convenience method and will generally use other + flavours of writeData to complete the operation. The operation will fail if there is any + previous data associated with the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        writeString in class Storage
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The String data that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readData

        +
        public StorageResult readData(java.lang.String key)
+                       throws StorageException
        +
        Description copied from class: Storage
        +
        Fetches generic data from the Store. The operation will fail if there is no + previous data associated with the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        readData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        Returns:
        +
        StorageResult ,which is expected to have + - the requested data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readData

        +
        public void readData(java.lang.String key,
+                     StorageResultReceiver callback)
+              throws StorageException
        +
        Description copied from class: Storage
        +
        Fetches generic data from the Store. The operation will fail if there is no + previous data associated with the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        readData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        callback - send a StorageResult, which is expected to have + - the requested data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readString

        +
        public StorageResult readString(java.lang.String key)
+                         throws StorageException
        +
        Description copied from class: Storage
        +
        Fetches String data from the Store. The operation will fail if there is no + previous data associated with the key.This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        readString in class Storage
        +
        Parameters:
        +
        key - The key for which the String data has to be retrieved
        +
        Returns:
        +
        StorageResult ,which is expected to have + - the String data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readString

        +
        public void readString(java.lang.String key,
+                       StorageResultReceiver callback)
+                throws StorageException
        +
        Description copied from class: Storage
        +
        Fetches String from the Store. The operation will fail if there is no + previous data associated with the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        readString in class Storage
        +
        Parameters:
        +
        key - The key for which the String data has to be retrieved
        +
        callback - send a StorageResult, which is expected to have + - the requested data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        updateData

        +
        public StorageResult updateData(java.lang.String key,
+                                byte[] value)
+                         throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will only update, if the data + already exists for the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        updateData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        updateData

        +
        public void updateData(java.lang.String key,
+                       byte[] value,
+                       StorageResultReceiver callback)
+                throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will only update, if the data + already exists for the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        updateData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        updateString

        +
        public StorageResult updateString(java.lang.String key,
+                                  java.lang.String value)
+                           throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new String. This operation will only update, if the data + already exists for the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        updateString in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        updateString

        +
        public void updateString(java.lang.String key,
+                         java.lang.String value,
+                         StorageResultReceiver callback)
+                  throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new String. This operation will only update, if the data + already exists for the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        updateString in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateData

        +
        public StorageResult writeOrUpdateData(java.lang.String key,
+                                       byte[] value)
+                                throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. This method is expected to + block and hence its recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        writeOrUpdateData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateData

        +
        public void writeOrUpdateData(java.lang.String key,
+                              byte[] value,
+                              StorageResultReceiver callback)
+                       throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. Implementations are requested + to offload all heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        writeOrUpdateData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateString

        +
        public StorageResult writeOrUpdateString(java.lang.String key,
+                                         java.lang.String value)
+                                  throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. This method is expected to + block and hence its recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        writeOrUpdateString in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateString

        +
        public void writeOrUpdateString(java.lang.String key,
+                                java.lang.String value,
+                                StorageResultReceiver callback)
+                         throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. Implementations are requested + to offload all heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        writeOrUpdateString in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        deleteData

        +
        public StorageResult deleteData(java.lang.String key)
+                         throws StorageException
        +
        Description copied from class: Storage
        +
        Deletes an entry, essentially a key-value pair, from the storage. This method is expected to + block and hence its recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        deleteData in class Storage
        +
        Parameters:
        +
        key - The key for which the data will be deleted
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + + + + + +
        +
      • +

        deleteData

        +
        public void deleteData(java.lang.String key,
+                       StorageResultReceiver callback)
+                throws StorageException
        +
        Description copied from class: Storage
        +
        Deletes an entry, essentially a key-value pair, from the storage. Implementations are + requested to offload all heavy duty work to another thread and use the callback to + notify the caller.
        +
        +
        Specified by:
        +
        deleteData in class Storage
        +
        Parameters:
        +
        key - The key for which the data will be deleted
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        deleteAll

        +
        public StorageResult deleteAll()
        +
        Description copied from class: Storage
        +
        Deletes all entries from the storage. This method is expected to block and hence + its recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        deleteAll in class Storage
        +
        Returns:
        +
        StorageResult which is expected to have + - status part to be SUCCESS, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public void deleteAll(StorageResultReceiver callback)
+               throws StorageException
        +
        Description copied from class: Storage
        +
        Deletes all entries from the storage. Implementations are requested to offload all heavy + duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        deleteAll in class Storage
        +
        Parameters:
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - status part to be SUCCESS, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        getAllKeys

        +
        public StorageResult getAllKeys()
        +
        Description copied from class: Storage
        +
        Fetch all the keys against which data are stored. This method is expected to block and hence + its recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        getAllKeys in class Storage
        +
        Returns:
        +
        An StorageResult , which is expected to have + - a list of all the keys (or an empty list) as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        +
        • +
      + + + +
        +
      • +

        getAllKeys

        +
        public void getAllKeys(StorageResultReceiver callback)
+                throws StorageException
        +
        Description copied from class: Storage
        +
        Fetch all the keys against which data are stored. Implementations are requested to offload + all heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        getAllKeys in class Storage
        +
        Parameters:
        +
        callback - send a StorageResult , which is expected to have + - a list of all the keys (or an empty list) as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        updateAccountKeyIndex

        +
        private void updateAccountKeyIndex(android.content.Context ctx,
+                                   java.lang.String key,
+                                   java.lang.String value)
+                            throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        writeAccountData

        +
        private void writeAccountData(android.content.Context ctx,
+                              java.lang.String encodedKey,
+                              java.lang.String value)
+                       throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        readAccountData

        +
        private java.lang.String readAccountData(android.content.Context ctx,
+                                         java.lang.String key)
+                                  throws java.lang.Exception
        +
        +
        Throws:
        +
        java.lang.Exception
        +
        +
        • +
      + + + +
        +
      • +

        validateInputs

        +
        private void validateInputs(java.lang.String key,
+                            java.lang.String value)
+                     throws StorageException
        +
        This methods checks for cases such as null or min and max length of the key and data.
        +
        +
        Parameters:
        +
        key - the key to put in the store
        +
        value - the value corresponding to the key to be put in the store
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        validateInputs

        +
        private void validateInputs(java.lang.String key,
+                            byte[] value)
+                     throws StorageException
        +
        This methods checks for cases such as null or min and max length of the key and data.
        +
        +
        Parameters:
        +
        key - the key to put in the store
        +
        value - the value corresponding to the key to be put in the store
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/KeyStoreStorage.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/KeyStoreStorage.html new file mode 100644 index 00000000..dd68ac6a --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/KeyStoreStorage.html @@ -0,0 +1,1297 @@ + + + + + +KeyStoreStorage + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.ca.mas.core.storage.implementation
+

Class KeyStoreStorage

+
+
+ +
+
    +
  • +
    +
    +
    public final class KeyStoreStorage
+extends Storage
    +
    KeyStore backed Storage implementation.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ks

        +
        private KeyStore ks
        +
        The L7 KeyStore utility instance.
        +
        • +
      + + + +
        +
      • +

        prefix

        +
        private java.lang.String prefix
        +
        Key Prefix. + The value will be the package name for private mode and "SHARED_" for shared mode.
        +
        • +
      + + + +
        +
      • +

        MAX_KEY_SIZE

        +
        private static int MAX_KEY_SIZE
        +
        MAX size of the Key, in characters, that can be written in to this storage. + Please note that this is inclusive of the prefix.
        +
        • +
      + + + +
        +
      • +

        MAX_DATA_SIZE

        +
        private static final int MAX_DATA_SIZE
        +
        MAX size of data, in bytes, that can be written in to this storage.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KeyStoreStorage

        +
        protected KeyStoreStorage(java.lang.Object options)
+                   throws StorageException
        +
        Initialize the storage.
        +
        +
        Parameters:
        +
        options - Object[] with 2 elements + 1) An android.content.Context + 2) (optional) Boolean value indicating whether the storage is Shared or not
        +
        Throws:
        +
        StorageException - if initialization of storage fails.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        writeData

        +
        public StorageResult writeData(java.lang.String key,
+                               byte[] value)
+                        throws StorageException
        +
        Description copied from class: Storage
        +
        Writes some generic data to the Storage. The operation will fail if there is any previous + data associated with the key. This method is expected to block and hence its recommended to + call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        writeData in class Storage
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The generic data that needs to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeData

        +
        public void writeData(java.lang.String key,
+                      byte[] value,
+                      StorageResultReceiver callback)
+               throws StorageException
        +
        Description copied from class: Storage
        +
        Writes some generic data to the Storage. The operation will fail if there is any previous + data associated with the key. Implementations are requested to offload all heavy duty work to + another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        writeData in class Storage
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The generic data that needs to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeString

        +
        public StorageResult writeString(java.lang.String key,
+                                 java.lang.String value)
+                          throws StorageException
        +
        Description copied from class: Storage
        +
        Writes String data to the Storage. This is a convenience method and will generally use other + flavours of writeData to complete the operation. The operation will fail if there is any + previous data associated with the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        writeString in class Storage
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The String data that need to be stored
        +
        Returns:
        +
        StorageResult ,which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeString

        +
        public void writeString(java.lang.String key,
+                        java.lang.String value,
+                        StorageResultReceiver callback)
+                 throws StorageException
        +
        Description copied from class: Storage
        +
        Writes String data to the Storage. This is a convenience method and will generally use other + flavours of writeData to complete the operation. The operation will fail if there is any + previous data associated with the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        writeString in class Storage
        +
        Parameters:
        +
        key - The key against which the data has to be stored
        +
        value - The String data that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readData

        +
        public StorageResult readData(java.lang.String key)
+                       throws StorageException
        +
        Description copied from class: Storage
        +
        Fetches generic data from the Store. The operation will fail if there is no + previous data associated with the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        readData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        Returns:
        +
        StorageResult ,which is expected to have + - the requested data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readData

        +
        public void readData(java.lang.String key,
+                     StorageResultReceiver callback)
+              throws StorageException
        +
        Description copied from class: Storage
        +
        Fetches generic data from the Store. The operation will fail if there is no + previous data associated with the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        readData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        callback - send a StorageResult, which is expected to have + - the requested data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readString

        +
        public StorageResult readString(java.lang.String key)
+                         throws StorageException
        +
        Description copied from class: Storage
        +
        Fetches String data from the Store. The operation will fail if there is no + previous data associated with the key.This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        readString in class Storage
        +
        Parameters:
        +
        key - The key for which the String data has to be retrieved
        +
        Returns:
        +
        StorageResult ,which is expected to have + - the String data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        readString

        +
        public void readString(java.lang.String key,
+                       StorageResultReceiver callback)
+                throws StorageException
        +
        Description copied from class: Storage
        +
        Fetches String from the Store. The operation will fail if there is no + previous data associated with the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        readString in class Storage
        +
        Parameters:
        +
        key - The key for which the String data has to be retrieved
        +
        callback - send a StorageResult, which is expected to have + - the requested data as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        updateData

        +
        public StorageResult updateData(java.lang.String key,
+                                byte[] value)
+                         throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will only update, if the data + already exists for the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        updateData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        updateData

        +
        public void updateData(java.lang.String key,
+                       byte[] value,
+                       StorageResultReceiver callback)
+                throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will only update, if the data + already exists for the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        updateData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        updateString

        +
        public StorageResult updateString(java.lang.String key,
+                                  java.lang.String value)
+                           throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new String. This operation will only update, if the data + already exists for the key. This method is expected to block and hence its + recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        updateString in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        updateString

        +
        public void updateString(java.lang.String key,
+                         java.lang.String value,
+                         StorageResultReceiver callback)
+                  throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new String. This operation will only update, if the data + already exists for the key. Implementations are requested to offload all + heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        updateString in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateData

        +
        public StorageResult writeOrUpdateData(java.lang.String key,
+                                       byte[] value)
+                                throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. This method is expected to + block and hence its recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        writeOrUpdateData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateData

        +
        public void writeOrUpdateData(java.lang.String key,
+                              byte[] value,
+                              StorageResultReceiver callback)
+                       throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. Implementations are requested + to offload all heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        writeOrUpdateData in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateString

        +
        public StorageResult writeOrUpdateString(java.lang.String key,
+                                         java.lang.String value)
+                                  throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. This method is expected to + block and hence its recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        writeOrUpdateString in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + +
        +
      • +

        writeOrUpdateString

        +
        public void writeOrUpdateString(java.lang.String key,
+                                java.lang.String value,
+                                StorageResultReceiver callback)
+                         throws StorageException
        +
        Description copied from class: Storage
        +
        Updates a pre-existing data with a new one. This operation will update, if the data + already exists for the key and if there is none, will create. Implementations are requested + to offload all heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        writeOrUpdateString in class Storage
        +
        Parameters:
        +
        key - The key for which the data has to be retrieved
        +
        value - The new String data, that need to be stored
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        deleteData

        +
        public StorageResult deleteData(java.lang.String key)
+                         throws StorageException
        +
        Description copied from class: Storage
        +
        Deletes an entry, essentially a key-value pair, from the storage. This method is expected to + block and hence its recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        deleteData in class Storage
        +
        Parameters:
        +
        key - The key for which the data will be deleted
        +
        Returns:
        +
        StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + + + + + +
        +
      • +

        deleteData

        +
        public void deleteData(java.lang.String key,
+                       StorageResultReceiver callback)
+                throws StorageException
        +
        Description copied from class: Storage
        +
        Deletes an entry, essentially a key-value pair, from the storage. Implementations are + requested to offload all heavy duty work to another thread and use the callback to + notify the caller.
        +
        +
        Specified by:
        +
        deleteData in class Storage
        +
        Parameters:
        +
        key - The key for which the data will be deleted
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - the key as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        deleteAll

        +
        public StorageResult deleteAll()
        +
        Description copied from class: Storage
        +
        Deletes all entries from the storage. This method is expected to block and hence + its recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        deleteAll in class Storage
        +
        Returns:
        +
        StorageResult which is expected to have + - status part to be SUCCESS, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        +
        • +
      + + + +
        +
      • +

        deleteAll

        +
        public void deleteAll(StorageResultReceiver callback)
+               throws StorageException
        +
        Description copied from class: Storage
        +
        Deletes all entries from the storage. Implementations are requested to offload all heavy + duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        deleteAll in class Storage
        +
        Parameters:
        +
        callback - Notifies the caller with a StorageResult which is expected to have + - status part to be SUCCESS, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        getAllKeys

        +
        public StorageResult getAllKeys()
        +
        Description copied from class: Storage
        +
        Fetch all the keys against which data are stored. This method is expected to block and hence + its recommended to call this method from a non-UI thread.
        +
        +
        Specified by:
        +
        getAllKeys in class Storage
        +
        Returns:
        +
        An StorageResult , which is expected to have + - a list of all the keys (or an empty list) as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        +
        • +
      + + + +
        +
      • +

        getAllKeys

        +
        public void getAllKeys(StorageResultReceiver callback)
+                throws StorageException
        +
        Description copied from class: Storage
        +
        Fetch all the keys against which data are stored. Implementations are requested to offload + all heavy duty work to another thread and use the callback to notify the caller.
        +
        +
        Specified by:
        +
        getAllKeys in class Storage
        +
        Parameters:
        +
        callback - send a StorageResult , which is expected to have + - a list of all the keys (or an empty list) as the data part, if the operation is a SUCCESS + - StorageException as the data part, if the operation is a FAILURE
        +
        Throws:
        +
        StorageException - if input validation fails.
        +
        +
        • +
      + + + +
        +
      • +

        sanitizeKey

        +
        private java.lang.String sanitizeKey(java.lang.String key)
        +
        Adds the prefix to the key. Beware that this method is dumb and + does not check if the key is already prefixed or not.
        +
        +
        Parameters:
        +
        key - Key to sanitize.
        +
        Returns:
        +
        Prefix and key.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        validateInputs

        +
        private void validateInputs(java.lang.String key,
+                            java.lang.String value)
+                     throws StorageException
        +
        +
        Throws:
        +
        StorageException
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        rcToStr

        +
        private java.lang.String rcToStr(int rc)
        +
        • +
      + + + +
        +
      • +

        isReady

        +
        private boolean isReady(StorageResult result)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/MASStorageManager.MASStorageType.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/MASStorageManager.MASStorageType.html index 7fa58c46..ce6a5d33 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/MASStorageManager.MASStorageType.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/MASStorageManager.MASStorageType.html @@ -2,9 +2,9 @@ - -MASStorageManager.MASStorageType (mas-foundation API) - + +MASStorageManager.MASStorageType + @@ -12,14 +12,14 @@ @@ -12,7 +12,7 @@ @@ -13,6 +13,10 @@

Classes

Enums

diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/package-summary.html index d3744c54..3b66089f 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/package-summary.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/implementation/package-summary.html @@ -2,9 +2,9 @@ - -com.ca.mas.core.storage.implementation (mas-foundation API) - + +com.ca.mas.core.storage.implementation + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + +

com.ca.mas.core.storage

+
+

Classes

+ +

Enums

+ +

Exceptions

+ +
+ + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/package-summary.html new file mode 100644 index 00000000..eeafacbc --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/package-summary.html @@ -0,0 +1,190 @@ + + + + + +com.ca.mas.core.storage + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.ca.mas.core.storage

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/package-tree.html new file mode 100644 index 00000000..2802e558 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/package-tree.html @@ -0,0 +1,159 @@ + + + + + +com.ca.mas.core.storage Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.ca.mas.core.storage

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • com.ca.mas.core.storage.Storage
      • +
    • com.ca.mas.core.storage.StorageResult (implements android.os.Parcelable)
      • +
    • com.ca.mas.core.storage.StorageResultReceiver
      • +
    • java.lang.Throwable (implements java.io.Serializable) +
        +
      • java.lang.Exception + +
        • +
      +
      • +
    +
    • +
+

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/sharedstorage/MASAuthenticator.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/sharedstorage/MASAuthenticator.html index e20dbc16..af85dcd5 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/sharedstorage/MASAuthenticator.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/sharedstorage/MASAuthenticator.html @@ -2,9 +2,9 @@ - -MASAuthenticator (mas-foundation API) - + +MASAuthenticator + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,13 +12,13 @@ @@ -16,6 +16,7 @@

Classes

  • MASAuthenticator
  • MASAuthenticatorService
  • MASSharedStorage
    • +
  • SharedStorageIdentifier
    • diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/sharedstorage/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/sharedstorage/package-summary.html index 7950bc6f..2309120e 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/sharedstorage/package-summary.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/storage/sharedstorage/package-summary.html @@ -2,9 +2,9 @@ - -com.ca.mas.core.storage.sharedstorage (mas-foundation API) - + +com.ca.mas.core.storage.sharedstorage + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.store
    +

    Interface ClientCredentialContainer

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      ClientCredentialStorage
      +
      +
      +
      +
      public interface ClientCredentialContainer
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          saveClientCredentials

          +
          void saveClientCredentials(ClientCredentials clientCredentials)
          +
          • +
        + + + +
          +
        • +

          getMasterClientId

          +
          java.lang.String getMasterClientId()
          +
          • +
        + + + +
          +
        • +

          getClientId

          +
          java.lang.String getClientId()
          +
          • +
        + + + +
          +
        • +

          getClientSecret

          +
          java.lang.String getClientSecret()
          +
          • +
        + + + +
          +
        • +

          getClientExpiration

          +
          java.lang.Long getClientExpiration()
          +
          • +
        + + + +
          +
        • +

          clear

          +
          void clear()
          +
          • +
        + + + +
          +
        • +

          clearAll

          +
          void clearAll()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/ClientCredentialStorage.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/ClientCredentialStorage.html new file mode 100644 index 00000000..6ca5fbf7 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/ClientCredentialStorage.html @@ -0,0 +1,449 @@ + + + + + +ClientCredentialStorage + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.core.store
    +

    Class ClientCredentialStorage

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.core.store.ClientCredentialStorage
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/OAuthTokenContainer.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/OAuthTokenContainer.html new file mode 100644 index 00000000..24dbb5c8 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/OAuthTokenContainer.html @@ -0,0 +1,324 @@ + + + + + +OAuthTokenContainer + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.store
    +

    Interface OAuthTokenContainer

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      PrivateTokenStorage
      +
      +
      +
      +
      public interface OAuthTokenContainer
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          saveAccessToken

          +
          void saveAccessToken(java.lang.String accessToken,
+                     java.lang.String refreshToken,
+                     long expiresInSec,
+                     java.lang.String grantedScope)
          +
          • +
        + + + +
          +
        • +

          getAccessToken

          +
          java.lang.String getAccessToken()
          +
          • +
        + + + +
          +
        • +

          getRefreshToken

          +
          java.lang.String getRefreshToken()
          +
          • +
        + + + +
          +
        • +

          getGrantedScope

          +
          java.lang.String getGrantedScope()
          +
          • +
        + + + +
          +
        • +

          takeRefreshToken

          +
          java.lang.String takeRefreshToken()
          +
          • +
        + + + +
          +
        • +

          getExpiry

          +
          long getExpiry()
          +
          +
          Returns:
          +
          expiry date as millis since the epoch, or 0 if not set.
          +
          +
          • +
        + + + +
          +
        • +

          clear

          +
          void clear()
          +
          • +
        + + + +
          +
        • +

          clearAll

          +
          void clearAll()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/PrivateTokenStorage.KEY.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/PrivateTokenStorage.KEY.html new file mode 100644 index 00000000..8596ad73 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/PrivateTokenStorage.KEY.html @@ -0,0 +1,391 @@ + + + + + +PrivateTokenStorage.KEY + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.core.store
    +

    Enum PrivateTokenStorage.KEY

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static PrivateTokenStorage.KEY[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (PrivateTokenStorage.KEY c : PrivateTokenStorage.KEY.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static PrivateTokenStorage.KEY valueOf(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/PrivateTokenStorage.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/PrivateTokenStorage.html new file mode 100644 index 00000000..93853a8e --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/PrivateTokenStorage.html @@ -0,0 +1,474 @@ + + + + + +PrivateTokenStorage + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.core.store
    +

    Class PrivateTokenStorage

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.core.store.PrivateTokenStorage
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClass and Description
        static class PrivateTokenStorage.KEY 
        +
        • +
      + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        private DataSource<java.lang.String,java.lang.String>storage 
        +
        • +
      + + + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        voidclear() 
        voidclearAll() 
        java.lang.StringgetAccessToken() 
        longgetExpiry() 
        java.lang.StringgetGrantedScope() 
        private java.lang.StringgetKey(java.lang.String name) 
        java.lang.StringgetRefreshToken() 
        voidsaveAccessToken(java.lang.String accessToken, + java.lang.String refreshToken, + long expiresInSec, + java.lang.String grantedScope) 
        java.lang.StringtakeRefreshToken() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    + +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/StorageProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/StorageProvider.html new file mode 100644 index 00000000..b93a04fd --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/StorageProvider.html @@ -0,0 +1,513 @@ + + + + + +StorageProvider + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.core.store
    +

    Class StorageProvider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.core.store.StorageProvider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class StorageProvider
+extends java.lang.Object
      +
      Utility class to retrieve the Storage interface.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/TokenManager.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/TokenManager.html new file mode 100644 index 00000000..2d8e2bf9 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/TokenManager.html @@ -0,0 +1,496 @@ + + + + + +TokenManager + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.store
    +

    Interface TokenManager

    +
    +
    +
    +
      +
    • +
      +
      All Superinterfaces:
      +
      TokenProvider
      +
      +
      +
      All Known Implementing Classes:
      +
      DefaultTokenManager
      +
      +
      +
      +
      public interface TokenManager
+extends TokenProvider
      +
      Interface implemented by a persistent token store that provides read and write access to tokens, certs, and keys.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          saveUserProfile

          +
          void saveUserProfile(java.lang.String userProfile)
+              throws TokenStoreException
          +
          Save the specified client username to the persistent store.
          +
          +
          Parameters:
          +
          userProfile - the user profile to save. Required.
          +
          Throws:
          +
          TokenStoreException - if there is a problem saving to the persistent store
          +
          +
          • +
        + + + +
          +
        • +

          saveMagIdentifier

          +
          void saveMagIdentifier(java.lang.String deviceIdentifier)
+                throws TokenStoreException
          +
          Save the specified server-assigned device identifier string. +

          + The identifier is assigned by the token server when we register the device. + It is expected to be a base-64 encoded token whose contents are opaque to the client.

          +
          +
          Parameters:
          +
          deviceIdentifier - a device identifier assigned to this device by the token server upon registration. Required.
          +
          Throws:
          +
          TokenStoreException - if there is a problem saving to the persistent store
          +
          +
          • +
        + + + +
          +
        • +

          saveClientCertificateChain

          +
          void saveClientCertificateChain(java.security.cert.X509Certificate[] chain)
+                         throws TokenStoreException
          +
          Save the specified certificate chain to the persistent store. +

          + The chain must be non-empty and the certificate in the zeroth index + must have a public key which matches the saved client public key.

          +
          +
          Parameters:
          +
          chain - the new client certificate chain. Required.
          +
          Throws:
          +
          TokenStoreException - if there is a problem saving to the persistent store
          +
          +
          • +
        + + + +
          +
        • +

          saveIdToken

          +
          void saveIdToken(IdToken idToken)
+          throws TokenStoreException
          +
          Save the specified ID token to the persistent store. +

          + Any existing ID token in the store will be replaced.

          +
          +
          Parameters:
          +
          idToken - the new ID token. Required.
          +
          Throws:
          +
          TokenStoreException - if there is a problem saving to the persistent store
          +
          +
          • +
        + + + +
          +
        • +

          deleteIdToken

          +
          void deleteIdToken()
+            throws TokenStoreException
          +
          Delete any saved ID token from the persistent store.
          +
          +
          Throws:
          +
          TokenStoreException - if there is a problem deleting from the persistent store
          +
          +
          • +
        + + + +
          +
        • +

          saveSecureIdToken

          +
          void saveSecureIdToken(byte[] idToken)
+                throws TokenStoreException
          +
          Save the specified encrypted ID token to the persistent store. +

          + Any existing ID token in the store will be replaced.

          +
          +
          Parameters:
          +
          idToken - the new ID token. Required.
          +
          Throws:
          +
          TokenStoreException - if there is a problem saving to the persistent store
          +
          +
          • +
        + + + +
          +
        • +

          deleteSecureIdToken

          +
          void deleteSecureIdToken()
+                  throws TokenStoreException
          +
          Delete any saved encrypted ID token from the persistent store.
          +
          +
          Throws:
          +
          TokenStoreException - if there is a problem deleting from the persistent store
          +
          +
          • +
        + + + +
          +
        • +

          deleteUserProfile

          +
          void deleteUserProfile()
+                throws TokenStoreException
          +
          Delete any saved user profile from the persistent store.
          +
          +
          Throws:
          +
          TokenStoreException - if there is a problem deleting from the persistent store
          +
          +
          • +
        + + + +
          +
        • +

          clear

          +
          void clear()
+    throws TokenStoreException
          +
          Delete shared objects from the persistent store which associate withe the current connected gateway. + This includes any ID token, client cert public and private key, and client cert chain.
          +
          +
          Throws:
          +
          TokenStoreException - if there is a problem deleting from the persistent store
          +
          +
          • +
        + + + +
          +
        • +

          clearAll

          +
          void clearAll()
+       throws TokenStoreException
          +
          Delete all shared objects from the persistent store. + This includes any ID token, client cert public and private key, and client cert chain.
          +
          +
          Throws:
          +
          TokenStoreException - if there is a problem deleting from the persistent store
          +
          +
          • +
        + + + +
          +
        • +

          isTokenStoreReady

          +
          boolean isTokenStoreReady()
          +
          Check that the token store is unlocked and ready to use.
          +
          +
          Returns:
          +
          true if the token store is ready to use, and the various save methods should be expected to succeed. + false if the token store needs to be initialized (pass code set, device unlocked, etc)
          +
          +
          • +
        + + + +
          +
        • +

          getTokenStore

          +
          DataSource getTokenStore()
          +
          Gets the DataSource used to store the tokens.
          +
          +
          Returns:
          +
          Token Store as DataSource.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/TokenProvider.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/TokenProvider.html new file mode 100644 index 00000000..a0069f96 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/TokenProvider.html @@ -0,0 +1,420 @@ + + + + + +TokenProvider + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.store
    +

    Interface TokenProvider

    +
    +
    +
    +
      +
    • +
      +
      All Known Subinterfaces:
      +
      TokenManager
      +
      +
      +
      All Known Implementing Classes:
      +
      DefaultTokenManager
      +
      +
      +
      +
      public interface TokenProvider
      +
      Interface implemented by a persistent token store that provides read-only access to tokens, certs and keys.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethod and Description
        java.security.PrivateKeycreatePrivateKey(android.content.Context ctx, + int keyBits) +
        Create an RSA private key.
        +
        java.security.cert.X509Certificate[]getClientCertificateChain() +
        Get the persisted client cert chain, if available.
        +
        java.security.PrivateKeygetClientPrivateKey() +
        Get the persisted client private key, if available.
        +
        java.security.PublicKeygetClientPublicKey() +
        Get the persisted client public key, if available.
        +
        IdTokengetIdToken() +
        Get the persisted OAuth ID token, if available.
        +
        java.lang.StringgetMagIdentifier() +
        Get the device identifier assigned to this device by the token server when the device was registered, or null.
        +
        byte[]getSecureIdToken() +
        Get the encrypted OAuth ID token, if available.
        +
        java.lang.StringgetUserProfile() +
        Get the persistent client username, if available.
        +
        booleanisClientCertificateChainAvailable() +
        Quickly check if a persisted client cert chain is available without actually reading and instantiating it.
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getUserProfile

          +
          java.lang.String getUserProfile()
          +
          Get the persistent client username, if available.
          +
          +
          Returns:
          +
          the user profile, or null if a user profile has not been saved.
          +
          +
          • +
        + + + +
          +
        • +

          getMagIdentifier

          +
          java.lang.String getMagIdentifier()
          +
          Get the device identifier assigned to this device by the token server when the device was registered, or null. +

          + This is a Base-64 encoded string whose contents are opaque to the client.

          +
          +
          Returns:
          +
          the device identifier, or null if a device identifier has not been saved.
          +
          +
          • +
        + + + +
          +
        • +

          getClientPrivateKey

          +
          java.security.PrivateKey getClientPrivateKey()
          +
          Get the persisted client private key, if available. +

          + A key pair may become available in the persistent store some time before an actual certificate chain + becomes available if the client needs to wait for the server to approve a certificate signing request.

          +
          +
          Returns:
          +
          the client key pair, or null if a client key pair has not yet been saved.
          +
          +
          • +
        + + + +
          +
        • +

          getClientPublicKey

          +
          java.security.PublicKey getClientPublicKey()
          +
          Get the persisted client public key, if available. +

          + A key pair may become available in the persistent store some time before an actual certificate chain + becomes available if the client needs to wait for the server to approve a certificate signing request.

          +
          +
          Returns:
          +
          the client key pair, or null if a client key pair has not yet been saved.
          +
          +
          • +
        + + + +
          +
        • +

          createPrivateKey

          +
          java.security.PrivateKey createPrivateKey(android.content.Context ctx,
+                                          int keyBits)
+                                   throws KeyStoreException
          +
          Create an RSA private key. +

          + This will create a private key with a self-signed public key.

          +
          +
          Parameters:
          +
          ctx - Android Context
          +
          keyBits - the size of the key, 2048 default
          +
          Returns:
          +
          the client key pair, or null if a client key pair has not yet been saved.
          +
          Throws:
          +
          KeyStoreException
          +
          +
          • +
        + + + +
          +
        • +

          isClientCertificateChainAvailable

          +
          boolean isClientCertificateChainAvailable()
          +
          Quickly check if a persisted client cert chain is available without actually reading and instantiating it.
          +
          +
          Returns:
          +
          true if and only if getClientCertificateChain() would have returned non-null.
          +
          +
          • +
        + + + +
          +
        • +

          getClientCertificateChain

          +
          java.security.cert.X509Certificate[] getClientCertificateChain()
          +
          Get the persisted client cert chain, if available. +

          + A certificate chain may not be available even though a client key pair is available. For example, + the server may not yet have approved the client's certificate signing request.

          +
          +
          Returns:
          +
          the client cert chain, with the client cert itself in the zeroth position; or null + if a client cert chain has not yet been obtained or saved.
          +
          +
          • +
        + + + +
          +
        • +

          getIdToken

          +
          IdToken getIdToken()
          +
          Get the persisted OAuth ID token, if available. +

          + As far as this SDK is concerned this is just a long opaque string that is meaningful to the server. + It happens to be Base64-encoded JSON but we as the client will never need to parse it.

          +
          +
          Returns:
          +
          the ID token, or null if one has not yet been saved.
          +
          +
          • +
        + + + +
          +
        • +

          getSecureIdToken

          +
          byte[] getSecureIdToken()
          +
          Get the encrypted OAuth ID token, if available.
          +
          +
          Returns:
          +
          the encrypted ID token, or null if one has not yet been saved.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/TokenStoreException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/TokenStoreException.html new file mode 100644 index 00000000..f98020d1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/TokenStoreException.html @@ -0,0 +1,299 @@ + + + + + +TokenStoreException + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.store
    +

    Class TokenStoreException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • com.ca.mas.core.store.TokenStoreException
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class TokenStoreException
+extends java.lang.Exception
      +
      Exception thrown if the token store can't be accessed.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TokenStoreException

          +
          public TokenStoreException()
          +
          • +
        + + + +
          +
        • +

          TokenStoreException

          +
          public TokenStoreException(java.lang.String detailMessage)
          +
          • +
        + + + +
          +
        • +

          TokenStoreException

          +
          public TokenStoreException(java.lang.String detailMessage,
+                           java.lang.Throwable throwable)
          +
          • +
        + + + +
          +
        • +

          TokenStoreException

          +
          public TokenStoreException(java.lang.Throwable throwable)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/package-frame.html new file mode 100644 index 00000000..65a5d2a0 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/package-frame.html @@ -0,0 +1,40 @@ + + + + + +com.ca.mas.core.store + + + + + +

    com.ca.mas.core.store

    +
    +

    Interfaces

    + +

    Classes

    + +

    Enums

    + +

    Exceptions

    + +
    + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/package-summary.html new file mode 100644 index 00000000..4139fdf5 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/package-summary.html @@ -0,0 +1,229 @@ + + + + + +com.ca.mas.core.store + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package com.ca.mas.core.store

    +
    +
    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/package-tree.html new file mode 100644 index 00000000..e3983b39 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/store/package-tree.html @@ -0,0 +1,171 @@ + + + + + +com.ca.mas.core.store Class Hierarchy + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package com.ca.mas.core.store

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +

    Interface Hierarchy

    + +

    Enum Hierarchy

    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/ClientCredentials.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/ClientCredentials.html new file mode 100644 index 00000000..bc4ed142 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/ClientCredentials.html @@ -0,0 +1,389 @@ + + + + + +ClientCredentials + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.core.token
    +

    Class ClientCredentials

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.core.token.ClientCredentials
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class ClientCredentials
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        ClientCredentials(java.lang.String masterClientId, + java.lang.String clientId, + java.lang.String clientSecret, + java.lang.Long clientExpiration) 
        +
        • +
      + + +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          masterClientId

          +
          private java.lang.String masterClientId
          +
          • +
        + + + +
          +
        • +

          clientId

          +
          private java.lang.String clientId
          +
          • +
        + + + +
          +
        • +

          clientSecret

          +
          private java.lang.String clientSecret
          +
          • +
        + + + +
          +
        • +

          clientExpiration

          +
          private java.lang.Long clientExpiration
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ClientCredentials

          +
          public ClientCredentials(java.lang.String masterClientId,
+                         java.lang.String clientId,
+                         java.lang.String clientSecret,
+                         java.lang.Long clientExpiration)
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMasterClientId

          +
          public java.lang.String getMasterClientId()
          +
          • +
        + + + +
          +
        • +

          getClientId

          +
          public java.lang.String getClientId()
          +
          • +
        + + + +
          +
        • +

          getClientSecret

          +
          public java.lang.String getClientSecret()
          +
          • +
        + + + +
          +
        • +

          getClientExpiration

          +
          public java.lang.Long getClientExpiration()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/IdToken.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/IdToken.html new file mode 100644 index 00000000..d625c594 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/IdToken.html @@ -0,0 +1,445 @@ + + + + + +IdToken + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.core.token
    +

    Class IdToken

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.core.token.IdToken
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      android.os.Parcelable
      +
      +
      +
      Direct Known Subclasses:
      +
      MASIdToken
      +
      +
      +
      +
      public class IdToken
+extends java.lang.Object
+implements android.os.Parcelable
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from interface android.os.Parcelable

          +android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>
          • +
        +
        • +
      + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        static android.os.Parcelable.Creator<IdToken>CREATOR 
        static java.lang.StringJWT_DEFAULT 
        private java.lang.Stringtype 
        private java.lang.Stringvalue 
        +
          +
        • + + +

          Fields inherited from interface android.os.Parcelable

          +CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ModifierConstructor and Description
        protected IdToken(android.os.Parcel in) 
         IdToken(java.lang.String value, + java.lang.String type) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        intdescribeContents() 
        java.lang.StringgetType() 
        java.lang.StringgetValue() 
        voidwriteToParcel(android.os.Parcel dest, + int flags) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          JWT_DEFAULT

          +
          public static final java.lang.String JWT_DEFAULT
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          value

          +
          private java.lang.String value
          +
          • +
        + + + +
          +
        • +

          type

          +
          private java.lang.String type
          +
          • +
        + + + +
          +
        • +

          CREATOR

          +
          public static final android.os.Parcelable.Creator<IdToken> CREATOR
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IdToken

          +
          public IdToken(java.lang.String value,
+               java.lang.String type)
          +
          • +
        + + + +
          +
        • +

          IdToken

          +
          protected IdToken(android.os.Parcel in)
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public java.lang.String getValue()
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public java.lang.String getType()
          +
          • +
        + + + +
          +
        • +

          describeContents

          +
          public int describeContents()
          +
          +
          Specified by:
          +
          describeContents in interface android.os.Parcelable
          +
          +
          • +
        + + + +
          +
        • +

          writeToParcel

          +
          public void writeToParcel(android.os.Parcel dest,
+                          int flags)
          +
          +
          Specified by:
          +
          writeToParcel in interface android.os.Parcelable
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTExpiredException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTExpiredException.html new file mode 100644 index 00000000..6de6929d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTExpiredException.html @@ -0,0 +1,316 @@ + + + + + +JWTExpiredException + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.token
    +

    Class JWTExpiredException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class JWTExpiredException
+extends JWTValidationException
      +
      This exception is thrown when the received JWT is expired.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JWTExpiredException

          +
          public JWTExpiredException()
          +
          • +
        + + + +
          +
        • +

          JWTExpiredException

          +
          public JWTExpiredException(java.lang.String detailMessage)
          +
          • +
        + + + +
          +
        • +

          JWTExpiredException

          +
          public JWTExpiredException(java.lang.String detailMessage,
+                           java.lang.Throwable throwable)
          +
          • +
        + + + +
          +
        • +

          JWTExpiredException

          +
          public JWTExpiredException(java.lang.Throwable throwable)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTInvalidAUDException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTInvalidAUDException.html new file mode 100644 index 00000000..eda783cb --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTInvalidAUDException.html @@ -0,0 +1,316 @@ + + + + + +JWTInvalidAUDException + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.token
    +

    Class JWTInvalidAUDException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class JWTInvalidAUDException
+extends JWTValidationException
      +
      This exception is thrown when the received JWT has invalid AUD.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JWTInvalidAUDException

          +
          public JWTInvalidAUDException()
          +
          • +
        + + + +
          +
        • +

          JWTInvalidAUDException

          +
          public JWTInvalidAUDException(java.lang.String detailMessage)
          +
          • +
        + + + +
          +
        • +

          JWTInvalidAUDException

          +
          public JWTInvalidAUDException(java.lang.String detailMessage,
+                              java.lang.Throwable throwable)
          +
          • +
        + + + +
          +
        • +

          JWTInvalidAUDException

          +
          public JWTInvalidAUDException(java.lang.Throwable throwable)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTInvalidAZPException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTInvalidAZPException.html new file mode 100644 index 00000000..2154758a --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTInvalidAZPException.html @@ -0,0 +1,316 @@ + + + + + +JWTInvalidAZPException + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.token
    +

    Class JWTInvalidAZPException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class JWTInvalidAZPException
+extends JWTValidationException
      +
      This exception is thrown when the received JWT has invalid AZP.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JWTInvalidAZPException

          +
          public JWTInvalidAZPException()
          +
          • +
        + + + +
          +
        • +

          JWTInvalidAZPException

          +
          public JWTInvalidAZPException(java.lang.String detailMessage)
          +
          • +
        + + + +
          +
        • +

          JWTInvalidAZPException

          +
          public JWTInvalidAZPException(java.lang.String detailMessage,
+                              java.lang.Throwable throwable)
          +
          • +
        + + + +
          +
        • +

          JWTInvalidAZPException

          +
          public JWTInvalidAZPException(java.lang.Throwable throwable)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTInvalidSignatureException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTInvalidSignatureException.html new file mode 100644 index 00000000..8ee3d5ab --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTInvalidSignatureException.html @@ -0,0 +1,316 @@ + + + + + +JWTInvalidSignatureException + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.token
    +

    Class JWTInvalidSignatureException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class JWTInvalidSignatureException
+extends JWTValidationException
      +
      This exception is thrown when the received JWT has invalid Signature.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JWTInvalidSignatureException

          +
          public JWTInvalidSignatureException()
          +
          • +
        + + + +
          +
        • +

          JWTInvalidSignatureException

          +
          public JWTInvalidSignatureException(java.lang.String detailMessage)
          +
          • +
        + + + +
          +
        • +

          JWTInvalidSignatureException

          +
          public JWTInvalidSignatureException(java.lang.String detailMessage,
+                                    java.lang.Throwable throwable)
          +
          • +
        + + + +
          +
        • +

          JWTInvalidSignatureException

          +
          public JWTInvalidSignatureException(java.lang.Throwable throwable)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTValidation.Algorithm.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTValidation.Algorithm.html new file mode 100644 index 00000000..d6972f48 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTValidation.Algorithm.html @@ -0,0 +1,379 @@ + + + + + +JWTValidation.Algorithm + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.core.token
    +

    Enum JWTValidation.Algorithm

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + +
        Enum Constants 
        Enum Constant and Description
        HS256 
        RSA 
        +
        • +
      + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        private intvalue 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static JWTValidation.AlgorithmvalueOf(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static JWTValidation.Algorithm[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          value

          +
          private int value
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static JWTValidation.Algorithm[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (JWTValidation.Algorithm c : JWTValidation.Algorithm.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static JWTValidation.Algorithm valueOf(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTValidation.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTValidation.html new file mode 100644 index 00000000..d6a96495 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTValidation.html @@ -0,0 +1,461 @@ + + + + + +JWTValidation + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.core.token
    +

    Class JWTValidation

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.core.token.JWTValidation
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class JWTValidation
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        static java.lang.StringALG 
        static java.lang.StringAUD 
        static java.lang.StringAZP 
        static java.lang.StringEXP 
        private static java.lang.StringTAG 
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        JWTValidation() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        private static java.lang.StringgetAlgorithm(java.lang.String header) 
        static booleanisIdTokenExpired(IdToken idToken) 
        static booleanvalidateIdToken(IdToken idToken, + java.lang.String deviceIdentifier, + java.lang.String clientId, + java.lang.String clientSecret) 
        private static booleanvalidateJwtPayload(JWTValidation.IdTokenDef idTokenDef, + java.lang.String deviceIdentifier, + java.lang.String clientId) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    + +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTValidationException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTValidationException.html new file mode 100644 index 00000000..5985f80e --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/JWTValidationException.html @@ -0,0 +1,321 @@ + + + + + +JWTValidationException + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.token
    +

    Class JWTValidationException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JWTValidationException

          +
          public JWTValidationException(int errorCode)
          +
          • +
        + + + +
          +
        • +

          JWTValidationException

          +
          public JWTValidationException(int errorCode,
+                              java.lang.String detailMessage)
          +
          • +
        + + + +
          +
        • +

          JWTValidationException

          +
          public JWTValidationException(int errorCode,
+                              java.lang.String detailMessage,
+                              java.lang.Throwable throwable)
          +
          • +
        + + + +
          +
        • +

          JWTValidationException

          +
          public JWTValidationException(int errorCode,
+                              java.lang.Throwable throwable)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/package-frame.html new file mode 100644 index 00000000..987cbaef --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/package-frame.html @@ -0,0 +1,36 @@ + + + + + +com.ca.mas.core.token + + + + + +

    com.ca.mas.core.token

    +
    +

    Classes

    + +

    Enums

    + +

    Exceptions

    + +
    + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/package-summary.html new file mode 100644 index 00000000..53fcb02d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/package-summary.html @@ -0,0 +1,212 @@ + + + + + +com.ca.mas.core.token + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package com.ca.mas.core.token

    +
    +
    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/package-tree.html new file mode 100644 index 00000000..c672d056 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/token/package-tree.html @@ -0,0 +1,171 @@ + + + + + +com.ca.mas.core.token Class Hierarchy + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package com.ca.mas.core.token

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.Binary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.Binary.html new file mode 100644 index 00000000..e23608a6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.Binary.html @@ -0,0 +1,227 @@ + + + + + +Functions.Binary + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.util
    +

    Interface Functions.Binary<R,A,B>

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Functions
      +
      +
      +
      +
      public static interface Functions.Binary<R,A,B>
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + + +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.BinaryVoid.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.BinaryVoid.html new file mode 100644 index 00000000..8a19abfc --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.BinaryVoid.html @@ -0,0 +1,227 @@ + + + + + +Functions.BinaryVoid + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.util
    +

    Interface Functions.BinaryVoid<A,B>

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Functions
      +
      +
      +
      +
      public static interface Functions.BinaryVoid<A,B>
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + + + +
          +
        • +

          call

          +
          void call(A a,
+          B b)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.Nullary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.Nullary.html new file mode 100644 index 00000000..ef7ee04b --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.Nullary.html @@ -0,0 +1,223 @@ + + + + + +Functions.Nullary + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.util
    +

    Interface Functions.Nullary<R>

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Functions
      +
      +
      +
      +
      public static interface Functions.Nullary<R>
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          call

          +
          R call()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.NullaryVoid.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.NullaryVoid.html new file mode 100644 index 00000000..d712479a --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.NullaryVoid.html @@ -0,0 +1,223 @@ + + + + + +Functions.NullaryVoid + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.util
    +

    Interface Functions.NullaryVoid

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Functions
      +
      +
      +
      +
      public static interface Functions.NullaryVoid
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          call

          +
          void call()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.Unary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.Unary.html new file mode 100644 index 00000000..c30d9902 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.Unary.html @@ -0,0 +1,225 @@ + + + + + +Functions.Unary + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.util
    +

    Interface Functions.Unary<R,A>

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Functions
      +
      +
      +
      +
      public static interface Functions.Unary<R,A>
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + + +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.UnaryVoid.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.UnaryVoid.html new file mode 100644 index 00000000..60b953dc --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.UnaryVoid.html @@ -0,0 +1,230 @@ + + + + + +Functions.UnaryVoid + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.util
    +

    Interface Functions.UnaryVoid<A>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      A - parameter type
      +
      +
      +
      Enclosing class:
      +
      Functions
      +
      +
      +
      +
      public static interface Functions.UnaryVoid<A>
      +
      A function that takes one argument and returns nothing.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + + + +
          +
        • +

          call

          +
          void call(A a)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.html new file mode 100644 index 00000000..18cbff5f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/Functions.html @@ -0,0 +1,279 @@ + + + + + +Functions + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.core.util
    +

    Class Functions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.core.util.Functions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class Functions
+extends java.lang.Object
      +
      Holds simple callback interfaces.
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ModifierConstructor and Description
        private Functions() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Functions

          +
          private Functions()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/KeyUtilsAsymmetric.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/KeyUtilsAsymmetric.html new file mode 100644 index 00000000..720288fe --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/KeyUtilsAsymmetric.html @@ -0,0 +1,885 @@ + + + + + +KeyUtilsAsymmetric + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.core.util
    +

    Class KeyUtilsAsymmetric

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.core.util.KeyUtilsAsymmetric
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class KeyUtilsAsymmetric
+extends java.lang.Object
      +
      Utility methods for working with keys and key pairs.
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ModifierConstructor and Description
        protected KeyUtilsAsymmetric() +
        Unused constructor
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        private static byte[]arrayConcat(java.util.ArrayList<byte[]> byteArrayList) +
        Combine the arrays
        +
        private static java.util.ArrayList<byte[]>arraySplit(byte[] bytes, + int eachLength) +
        Split the byte array into even chunks, last will be whatever is left over
        +
        static voidclearCertificateChain(java.lang.String aliasPrefix) +
        This will delete the existing certificate chain in the AndroidKeyStore.
        +
        static byte[]decrypt(java.security.PrivateKey privateKey, + byte[] contentToDecrypt) +
        Decrypt data using an RSA private key.
        +
        private static byte[]decryptSection(java.security.PrivateKey privateKey, + byte[] contentToDecrypt) +
        Decrypt data using an RSA private key, as long as the byte + length is around 70% less than the key size.
        +
        static voiddeletePrivateKey(java.lang.String alias) +
        Remove the existing public and private keypair.
        +
        static byte[]encrypt(java.security.PublicKey publicKey, + byte[] contentToEncrypt) +
        Encrypt data using an RSA public key,.
        +
        private static byte[]encryptSection(java.security.PublicKey publicKey, + byte[] contentToEncrypt) +
        Encrypt data using an RSA public key, as long as the + content is less than an eighth of the key size.
        +
        static java.security.PrivateKeygenerateRsaPrivateKey(int keysize, + java.lang.String alias, + java.lang.String dn, + boolean lollipopEncryptionRequired, + boolean marshmallowUserAuthenticationRequired, + int marshmallowUserAuthenticationValidityDurationSeconds, + boolean nougatInvalidatedByBiometricEnrollment) +
        Generate a new RSA keypair with the specified number of key bits.
        +
        static java.security.PrivateKeygenerateRsaPrivateKey(java.lang.String alias, + java.lang.String dn, + boolean lollipopEncryptionRequired, + boolean marshmallowUserAuthenticationRequired, + int marshmallowUserAuthenticationValidityDurationSeconds, + boolean nougatInvalidatedByBiometricEnrollment) 
        static java.security.cert.X509Certificate[]getCertificateChain(java.lang.String aliasPrefix) +
        This will return the CA-signed certificate chain stored in the + AndroidKeyStore.
        +
        static java.security.KeygetKeystoreKey(java.lang.String alias) +
        Gets the existing Android keystore key.
        +
        static java.security.PrivateKeygetRsaPrivateKey(java.lang.String alias) +
        Get the existing private key.
        +
        static java.security.PublicKeygetRsaPublicKey(java.lang.String alias) +
        Get the existing self-signed public key.
        +
        static java.lang.StringsanitizeAlias(java.lang.String alias) 
        static voidsetCertificateChain(java.lang.String aliasPrefix, + java.security.cert.X509Certificate[] chain) +
        This will install or replace the existing certificate chain in the AndroidKeyStore.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          ANDROID_KEY_STORE

          +
          private static final java.lang.String ANDROID_KEY_STORE
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          CIPHER_ENCRYPTION_ANDROID_M_PLUS

          +
          private static final java.lang.String CIPHER_ENCRYPTION_ANDROID_M_PLUS
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + + +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          KeyUtilsAsymmetric

          +
          protected KeyUtilsAsymmetric()
          +
          Unused constructor
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          generateRsaPrivateKey

          +
          public static java.security.PrivateKey generateRsaPrivateKey(int keysize,
+                                                             java.lang.String alias,
+                                                             java.lang.String dn,
+                                                             boolean lollipopEncryptionRequired,
+                                                             boolean marshmallowUserAuthenticationRequired,
+                                                             int marshmallowUserAuthenticationValidityDurationSeconds,
+                                                             boolean nougatInvalidatedByBiometricEnrollment)
+                                                      throws KeyStoreException
          +
          Generate a new RSA keypair with the specified number of key bits. + This will always create the key pair inside the AndroidKeyStore, + ensuring it is always protected. +

          + For Pre-M, lollipopEncryptionRequired requires that the user sets + a screen lock and that the keys will be encrypted at rest. +

          + For M+: + “The Android Keystore system lets you store cryptographic keys in a + container to make it more difficult to extract from the device. + Once keys are in the keystore, they can be used for cryptographic + operations with the key material remaining non-exportable”. + This means that the key can't be extracted from the keystore, and + note that keys can only be shared between applications with + the same signing key and shared user id. + Therefore, it is not necessary to protect private keys stored + in the AndroidKeyStore with a screen lock in the same way + encryption was required for Pre-M. +

          + The key protection parameters for M+ AndroidKeyStore RSA keys + marshmallowUserAuthenticationRequired, + marshmallowUserAuthenticationValidityDurationSeconds, + and nougatInvalidatedByBiometricEnrollment are linked, + below are the combinations: +

          + 1) Android M+: marshmallowUserAuthenticationRequired(false) – the keys + are still protected from export but can be used whenever needed. + 2) Android M+: marshmallowUserAuthenticationRequired(true) and + marshmallowUserAuthenticationValidityDurationSeconds( > 0 ) – + the key can only be used if the pin has been entered within the given + number of seconds. On some devices, when a fingerprint is added + the key is invalidated. The # seconds can be set absurdly high, + for example 100,000 if it's ok for more than a day to pass without + an unlock. + 3) Android M+: marshmallowUserAuthenticationRequired(true) and + marshmallowUserAuthenticationValidityDurationSeconds(zero or neg) – + works only with fingerprint+pin/swipe/pattern, and requires that + the fingerprint is entered every time a key is used. This requires + an added layer to prompt the user to swipe their fingerprint. + 4) Android N+: nougatInvalidatedByBiometricEnrollment(true/false) + changes the behavior in #2 – either the key will or won’t be + invalided when the user adds an or another fingerprint.

          +
          +
          Parameters:
          +
          keysize - the key size in bits, eg 2048.
          +
          alias - the keystore alias to use
          +
          dn - the dn for the initial self-signed certificate
          +
          lollipopEncryptionRequired - true/false for pre-Android-M: + requires that the user sets a screen lock and + that the keys will be encrypted at rest
          +
          marshmallowUserAuthenticationRequired - true/false for Android-M+: + requires a lock screen in order to use the key. If the validity duration + is equal to zero, a fingerprint validation is required for every use of the key.
          +
          marshmallowUserAuthenticationValidityDurationSeconds - # secs for Android-M+: + if user authentication is required, this specifies the number of seconds after + unlocking the screen where key is still usable. If this value is zero, a + fingerprint is required for every use.
          +
          nougatInvalidatedByBiometricEnrollment - true/false for Android-N+: + if setUserAuthenticationRequired true, some Android M devices may disable + a key if a fingerprint is added. Setting this value to true ensures + the key is usabl even if a fingerprint is added.
          +
          Returns:
          +
          a new RSA PrivateKey, created in and protected by the AndroidKeyStore. + The matching self-signed public certificate cannot be deleted.
          +
          Throws:
          +
          java.lang.RuntimeException - if an RSA key pair of the requested size cannot be generated
          +
          KeyStoreException
          +
          +
          • +
        + + + +
          +
        • +

          generateRsaPrivateKey

          +
          public static java.security.PrivateKey generateRsaPrivateKey(java.lang.String alias,
+                                                             java.lang.String dn,
+                                                             boolean lollipopEncryptionRequired,
+                                                             boolean marshmallowUserAuthenticationRequired,
+                                                             int marshmallowUserAuthenticationValidityDurationSeconds,
+                                                             boolean nougatInvalidatedByBiometricEnrollment)
+                                                      throws KeyStoreException
          +
          +
          Throws:
          +
          KeyStoreException
          +
          +
          • +
        + + + +
          +
        • +

          getKeystoreKey

          +
          public static java.security.Key getKeystoreKey(java.lang.String alias)
+                                        throws java.io.IOException,
+                                               java.security.KeyStoreException,
+                                               java.security.NoSuchAlgorithmException,
+                                               java.security.cert.CertificateException,
+                                               java.security.UnrecoverableKeyException
          +
          Gets the existing Android keystore key.
          +
          +
          Parameters:
          +
          alias - the alias of the existing private key
          +
          Returns:
          +
          the keystore Key
          +
          Throws:
          +
          java.io.IOException
          +
          java.security.KeyStoreException
          +
          java.security.NoSuchAlgorithmException
          +
          java.security.cert.CertificateException
          +
          java.security.UnrecoverableKeyException
          +
          +
          • +
        + + + +
          +
        • +

          sanitizeAlias

          +
          public static java.lang.String sanitizeAlias(java.lang.String alias)
          +
          • +
        + + + +
          +
        • +

          getRsaPrivateKey

          +
          public static java.security.PrivateKey getRsaPrivateKey(java.lang.String alias)
+                                                 throws KeyStoreException
          +
          Get the existing private key.
          +
          +
          Parameters:
          +
          alias - the alias of the existing private key
          +
          Returns:
          +
          the Private Key
          +
          Throws:
          +
          KeyStoreException
          +
          +
          • +
        + + + +
          +
        • +

          getRsaPublicKey

          +
          public static java.security.PublicKey getRsaPublicKey(java.lang.String alias)
+                                               throws KeyStoreException
          +
          Get the existing self-signed public key. + Note: the private key will always be associated with the initial + self-signed public certificate. The PublicKey can be + used in a Certificate Signing Request.
          +
          +
          Parameters:
          +
          alias - the alias of the existing private key
          +
          Returns:
          +
          the Private Key object
          +
          Throws:
          +
          KeyStoreException
          +
          +
          • +
        + + + +
          +
        • +

          deletePrivateKey

          +
          public static void deletePrivateKey(java.lang.String alias)
          +
          Remove the existing public and private keypair. This will + not remove a certificate chain stored separately.
          +
          +
          Parameters:
          +
          alias - the alias of the existing private key + + self-signed public key
          +
          +
          • +
        + + + +
          +
        • +

          setCertificateChain

          +
          public static void setCertificateChain(java.lang.String aliasPrefix,
+                                       java.security.cert.X509Certificate[] chain)
+                                throws KeyStoreException
          +
          This will install or replace the existing certificate chain in the AndroidKeyStore. + The chain will be stored as "alias#". + When private keys are generated, there is always a self-signed certificate + generated at the same time. In other keystore types, this self-signed certificate + can be replaced by a CA-signed public cert. For AndroidKeyStore, the self-signed + certificate cannot be replaced. Therefore, any new certificate chain generated + for the original public key will always remain. This will store the certificate + chain under a separate alias.
          +
          +
          Parameters:
          +
          aliasPrefix - the alias prefix to use, will be appended with position number, + where position 0 in the array will be 1.
          +
          chain - array of certificates in chain. Typically the public certificate + matching the private key will be in array position [0].
          +
          Throws:
          +
          KeyStoreException
          +
          +
          • +
        + + + +
          +
        • +

          getCertificateChain

          +
          public static java.security.cert.X509Certificate[] getCertificateChain(java.lang.String aliasPrefix)
+                                                                throws KeyStoreException
          +
          This will return the CA-signed certificate chain stored in the + AndroidKeyStore. Note this is stored separately from the + self-signed public certificate from any RSA keypair.
          +
          +
          Parameters:
          +
          aliasPrefix - Alias which which used to store the Certificate Chain
          +
          Returns:
          +
          The Certificate Chain
          +
          Throws:
          +
          KeyStoreException
          +
          +
          • +
        + + + +
          +
        • +

          clearCertificateChain

          +
          public static void clearCertificateChain(java.lang.String aliasPrefix)
          +
          This will delete the existing certificate chain in the AndroidKeyStore. + It will not delete any RSA self-signed public certificate from a + generated KeyPair. + The chain will be stored as "alias#".
          +
          +
          Parameters:
          +
          aliasPrefix - the alias prefix to use, will be appended with position number, + where position 0 in the array will be 1.
          +
          +
          • +
        + + + +
          +
        • +

          encryptSection

          +
          private static byte[] encryptSection(java.security.PublicKey publicKey,
+                                     byte[] contentToEncrypt)
+                              throws javax.crypto.NoSuchPaddingException,
+                                     java.security.InvalidKeyException,
+                                     javax.crypto.BadPaddingException,
+                                     java.security.NoSuchAlgorithmException,
+                                     javax.crypto.IllegalBlockSizeException,
+                                     java.security.InvalidAlgorithmParameterException
          +
          Encrypt data using an RSA public key, as long as the + content is less than an eighth of the key size. + If the key is stored in the AndroidKeyStore, it will + not have to be unlocked prior to encryption. + The maximum data size for encryption is dependent + upon the size of the key. For 2048-bit keys, + the limit is (256 - padding/11).
          +
          +
          Parameters:
          +
          publicKey - an RSA public key
          +
          contentToEncrypt - the bytes to encrypt - if the size + exceeds 256 bytes then the data cannot be encrypted using + this method
          +
          Returns:
          +
          encrypted bytes
          +
          Throws:
          +
          javax.crypto.NoSuchPaddingException
          +
          java.security.InvalidKeyException
          +
          javax.crypto.BadPaddingException
          +
          java.security.NoSuchAlgorithmException
          +
          javax.crypto.IllegalBlockSizeException
          +
          java.security.InvalidAlgorithmParameterException
          +
          +
          • +
        + + + +
          +
        • +

          decryptSection

          +
          private static byte[] decryptSection(java.security.PrivateKey privateKey,
+                                     byte[] contentToDecrypt)
+                              throws javax.crypto.NoSuchPaddingException,
+                                     java.security.InvalidKeyException,
+                                     javax.crypto.BadPaddingException,
+                                     java.security.NoSuchAlgorithmException,
+                                     javax.crypto.IllegalBlockSizeException,
+                                     java.security.InvalidAlgorithmParameterException
          +
          Decrypt data using an RSA private key, as long as the byte + length is around 70% less than the key size. + If the key is stored in the AndroidKeyStore, the keystore must + be unlocked prior to use.
          +
          +
          Parameters:
          +
          privateKey - an RSA private key
          +
          contentToDecrypt - the bytes to decrypt
          +
          Returns:
          +
          the decrypted bytes
          +
          Throws:
          +
          javax.crypto.NoSuchPaddingException
          +
          java.security.InvalidKeyException
          +
          javax.crypto.BadPaddingException
          +
          java.security.NoSuchAlgorithmException
          +
          javax.crypto.IllegalBlockSizeException
          +
          java.security.InvalidAlgorithmParameterException
          +
          +
          • +
        + + + +
          +
        • +

          decrypt

          +
          public static byte[] decrypt(java.security.PrivateKey privateKey,
+                             byte[] contentToDecrypt)
+                      throws javax.crypto.NoSuchPaddingException,
+                             java.security.InvalidKeyException,
+                             javax.crypto.BadPaddingException,
+                             java.security.NoSuchAlgorithmException,
+                             javax.crypto.IllegalBlockSizeException,
+                             java.security.InvalidAlgorithmParameterException
          +
          Decrypt data using an RSA private key. + If the key is stored in the AndroidKeyStore, the keystore must + be unlocked prior to use.
          +
          +
          Parameters:
          +
          privateKey - an RSA private key
          +
          contentToDecrypt - the bytes to decrypt
          +
          Returns:
          +
          the decrypted bytes
          +
          Throws:
          +
          javax.crypto.NoSuchPaddingException
          +
          java.security.InvalidKeyException
          +
          javax.crypto.BadPaddingException
          +
          java.security.NoSuchAlgorithmException
          +
          javax.crypto.IllegalBlockSizeException
          +
          java.security.InvalidAlgorithmParameterException
          +
          +
          • +
        + + + +
          +
        • +

          encrypt

          +
          public static byte[] encrypt(java.security.PublicKey publicKey,
+                             byte[] contentToEncrypt)
+                      throws javax.crypto.NoSuchPaddingException,
+                             java.security.InvalidKeyException,
+                             javax.crypto.BadPaddingException,
+                             java.security.NoSuchAlgorithmException,
+                             javax.crypto.IllegalBlockSizeException,
+                             java.security.InvalidAlgorithmParameterException
          +
          Encrypt data using an RSA public key,. + If the key is stored in the AndroidKeyStore, it will + not have to be unlocked prior to encryption. + The maximum data size for encryption is dependent + upon the size of the key. For 2048-bit keys, + the limit is (256 - padding/11).
          +
          +
          Parameters:
          +
          publicKey - an RSA public key
          +
          contentToEncrypt - the bytes to encrypt - if the size + exceeds 256 bytes then the data cannot be encrypted using + this method
          +
          Returns:
          +
          encrypted bytes
          +
          Throws:
          +
          javax.crypto.NoSuchPaddingException
          +
          java.security.InvalidKeyException
          +
          javax.crypto.BadPaddingException
          +
          java.security.NoSuchAlgorithmException
          +
          javax.crypto.IllegalBlockSizeException
          +
          java.security.InvalidAlgorithmParameterException
          +
          +
          • +
        + + + +
          +
        • +

          arrayConcat

          +
          private static byte[] arrayConcat(java.util.ArrayList<byte[]> byteArrayList)
          +
          Combine the arrays
          +
          +
          Parameters:
          +
          byteArrayList - list of byte arrays
          +
          Returns:
          +
          combined byte array
          +
          +
          • +
        + + + +
          +
        • +

          arraySplit

          +
          private static java.util.ArrayList<byte[]> arraySplit(byte[] bytes,
+                                                      int eachLength)
          +
          Split the byte array into even chunks, last will be whatever is left over
          +
          +
          Parameters:
          +
          bytes - the byte array to split
          +
          eachLength - the value to split by
          +
          Returns:
          +
          list of byte arrays
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/KeyUtilsSymmetric.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/KeyUtilsSymmetric.html new file mode 100644 index 00000000..441fce8c --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/KeyUtilsSymmetric.html @@ -0,0 +1,910 @@ + + + + + +KeyUtilsSymmetric + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.core.util
    +

    Class KeyUtilsSymmetric

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.core.util.KeyUtilsSymmetric
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class KeyUtilsSymmetric
+extends java.lang.Object
      +
      This interface is used to generate a SecretKey for encryption purposes. + For Android.M+, the key will be created in the AndroidKeyStore + and will remain there. + For Pre-Android.M, the key will be created and returned, and + a KeyStorageProvider must be used to protect the key. If + the user upgrades to Android.M+, the key will be moved + to the AndroidKeyStore.
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ModifierConstructor and Description
        protected KeyUtilsSymmetric() +
        Constructor, not necessary
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        private static voidcheckDeleteKeys(java.lang.String alias, + java.lang.Exception e) +
        If there is an exception with user not authenticated, delete the key
        +
        private static byte[]computeMac(java.lang.String key, + byte[] cipherText) +
        Computes the mac signature for the encrypted array
        +
        private static byte[]concatArrays(byte[] mac, + byte[] iv, + byte[] cipherText) +
        Combine the mac,iv and encrypted data arrays into one array
        +
        static byte[]decrypt(byte[] encryptedData, + javax.crypto.SecretKey secretKey, + java.lang.String key) +
        Decrypt the given data.
        +
        static voiddeleteKey(java.lang.String alias) +
        This method deletes the given key from AndroidKeyStore
        +
        private static voiddeleteKeyAndroidM(java.lang.String alias) +
        This method deletes the given key from AndroidKeyStore
        +
        private static voiddestroyKey(javax.crypto.SecretKey key) +
        Destroys the ephemeral key, in this case the Secret key generated for MAC, if the key implements Destroyable
        +
        static byte[]encrypt(byte[] data, + javax.crypto.SecretKey secretKey, + java.lang.String key) +
        Encrypts the given data.
        +
        static javax.crypto.SecretKeygenerateKey(java.lang.String alias, + java.lang.String algorithm, + int keyLength, + boolean inMemory, + boolean userAuthenticationRequired, + int userAuthenticationValiditySeconds, + boolean invalidatedByBiometricEnrollment) +
        Generate a symmetric key, allows for full selection of key properties
        +
        private static javax.crypto.SecretKeygenerateKeyInAndroidKeyStoreAndroidM(java.lang.String alias, + java.lang.String algorithm, + int keyLength, + boolean userAuthenticationRequired, + int userAuthenticationValiditySeconds) +
        For Android.M+ only, Return a secretKey to be used for encryption.
        +
        private static javax.crypto.SecretKeygenerateKeyInAndroidKeyStoreAndroidN(java.lang.String alias, + java.lang.String algorithm, + int keyLength, + boolean userAuthenticationRequired, + int userAuthenticationValiditySeconds, + boolean invalidatedByBiometricEnrollment) +
        For Android.N+ only, Return a secretKey to be used for encryption.
        +
        private static javax.crypto.SecretKeygenerateKeyInMemory(java.lang.String algorithm, + int keyLength) +
        Return a secretKey to be used for encryption.
        +
        private static byte[]getArraySubset(byte[] array, + int start, + int length) 
        static javax.crypto.SecretKeyretrieveKey(java.lang.String alias) +
        Retrieve the key from the AndroidKeyStore
        +
        private static javax.crypto.SecretKeyretrieveKeyAndroidM(java.lang.String alias) +
        Retrieve the key from the AndroidKeyStore
        +
        static booleanstoreKeyAndroidM(java.lang.String alias, + javax.crypto.SecretKey secretKey, + boolean userAuthenticationRequired, + int userAuthenticationValiditySeconds) +
        Stores a SecretKey in the AndroidKeyStore.
        +
        static booleanstoreKeyAndroidN(java.lang.String alias, + javax.crypto.SecretKey secretKey, + boolean userAuthenticationRequired, + int userAuthenticationValiditySeconds, + boolean invalidatedByBiometricEnrollment) +
        Stores a SecretKey in the AndroidKeyStore.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          KeyUtilsSymmetric

          +
          protected KeyUtilsSymmetric()
          +
          Constructor, not necessary
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          generateKey

          +
          public static javax.crypto.SecretKey generateKey(java.lang.String alias,
+                                                 java.lang.String algorithm,
+                                                 int keyLength,
+                                                 boolean inMemory,
+                                                 boolean userAuthenticationRequired,
+                                                 int userAuthenticationValiditySeconds,
+                                                 boolean invalidatedByBiometricEnrollment)
          +
          Generate a symmetric key, allows for full selection of key properties +

          + For M+: + “The Android Keystore system lets you store cryptographic keys in a + container to make it more difficult to extract from the device. + Once keys are in the keystore, they can be used for cryptographic + operations with the key material remaining non-exportable”. + This means that the key can't be extracted from the keystore, and + note that keys can only be shared between applications with + the same signing key and shared user id. +

          + The key protection parameters for M+ AndroidKeyStore AES keys + userAuthenticationRequired, + userAuthenticationValidityDurationSeconds, + and nougatInvalidatedByBiometricEnrollment are linked, + below are the combinations: +

          + 1) Android M+: userAuthenticationRequired(false) – the keys + are still protected from export but can be used whenever needed. + 2) Android M+: userAuthenticationRequired(true) and + userAuthenticationValidityDurationSeconds( > 0 ) – + the key can only be used if the pin has been entered within the given + number of seconds. On some devices, when a fingerprint is added + the key is invalidated. The # seconds can be set absurdly high, + for example 100,000 if it's ok for more than a day to pass without + an unlock. + 3) Android M+: userAuthenticationRequired(true) and + userAuthenticationValidityDurationSeconds(zero or neg) – + works only with fingerprint+pin/swipe/pattern, and requires that + the fingerprint is entered every time a key is used. This requires + an added layer to prompt the user to swipe their fingerprint. + 4) Android N+: nougatInvalidatedByBiometricEnrollment(true/false) + changes the behavior in #2 – either the key will or won’t be + invalided when the user adds an or another fingerprint.

          +
          +
          Parameters:
          +
          alias - the alias to use if generated in AndroidKeyStore
          +
          algorithm - AES or other Symmetric Key algorithm
          +
          keyLength - default is 256
          +
          inMemory - for Android.M+ the key will be created outside the AndroidKeyStore and then stored + inside. The in-memory copy can be used without user authentication until the + app is closed, dereferenced, or variable is destroyed. This is useful + for MASSessionLock and Unlock, where screen unlock is only needed for unlock.
          +
          userAuthenticationRequired - for Android.M+ require screen lock. Note, if inMemory is true, + this applies only to versions extracted from the AndroidKeyStore.
          +
          userAuthenticationValiditySeconds - sets the duration for which this key is authorized + to be used after the user is successfully authenticated.
          +
          invalidatedByBiometricEnrollment - true/false for Android-N+: + if setUserAuthenticationRequired true, some Android M devices may disable + a key if a fingerprint is added. Setting this value to true ensures + the key is usable even if a fingerprint is added.
          +
          Returns:
          +
          secret key
          +
          +
          • +
        + + + +
          +
        • +

          generateKeyInMemory

          +
          private static javax.crypto.SecretKey generateKeyInMemory(java.lang.String algorithm,
+                                                          int keyLength)
          +
          Return a secretKey to be used for encryption. + This key will be generated in memory and may + be vulnerable to discovery through memory scans. + This is useful for Pre-M devices, where AndroidKeyStore + is not supported and the key must be stored elsewhere. + This is also useful for session lock: the key can + be used right away without requiring authentication, + but stored protected in the AndroidKeyStore.
          +
          +
          Parameters:
          +
          algorithm - AES or other Symmetric Key algorithm
          +
          keyLength - default is 256
          +
          Returns:
          +
          secret key
          +
          +
          • +
        + + + +
          +
        • +

          generateKeyInAndroidKeyStoreAndroidM

          +
          private static javax.crypto.SecretKey generateKeyInAndroidKeyStoreAndroidM(java.lang.String alias,
+                                                                           java.lang.String algorithm,
+                                                                           int keyLength,
+                                                                           boolean userAuthenticationRequired,
+                                                                           int userAuthenticationValiditySeconds)
          +
          For Android.M+ only, Return a secretKey to be used for encryption.
          +
          +
          Parameters:
          +
          alias - the alias to use if generated in AndroidKeyStore
          +
          algorithm - AES or other Symmetric Key algorithm
          +
          keyLength - default is 256
          +
          userAuthenticationRequired - for Android.M+ require screen lock. Note, if inMemory is true, + this applies only to versions extracted from the AndroidKeyStore.
          +
          userAuthenticationValiditySeconds - sets the duration for which this key is authorized + to be used after the user is successfully authenticated.
          +
          Returns:
          +
          secret key
          +
          +
          • +
        + + + +
          +
        • +

          generateKeyInAndroidKeyStoreAndroidN

          +
          private static javax.crypto.SecretKey generateKeyInAndroidKeyStoreAndroidN(java.lang.String alias,
+                                                                           java.lang.String algorithm,
+                                                                           int keyLength,
+                                                                           boolean userAuthenticationRequired,
+                                                                           int userAuthenticationValiditySeconds,
+                                                                           boolean invalidatedByBiometricEnrollment)
          +
          For Android.N+ only, Return a secretKey to be used for encryption.
          +
          +
          Parameters:
          +
          alias - the alias to use if generated in AndroidKeyStore
          +
          algorithm - AES or other Symmetric Key algorithm
          +
          keyLength - default is 256
          +
          userAuthenticationRequired - for Android.M+ require screen lock. Note, if inMemory is true, + this applies only to versions extracted from the AndroidKeyStore.
          +
          userAuthenticationValiditySeconds - sets the duration for which this key is authorized + to be used after the user is successfully authenticated.
          +
          invalidatedByBiometricEnrollment - true/false for Android-N+: + if setUserAuthenticationRequired true, some Android M devices may disable + a key if a fingerprint is added. Setting this value to true ensures + the key is usable even if a fingerprint is added.
          +
          Returns:
          +
          secret key
          +
          +
          • +
        + + + +
          +
        • +

          retrieveKey

          +
          public static javax.crypto.SecretKey retrieveKey(java.lang.String alias)
          +
          Retrieve the key from the AndroidKeyStore
          +
          +
          Parameters:
          +
          alias - the alias to store the key as
          +
          Returns:
          +
          for Android Pre-M, this will return null + otherwise it will try to find the key in the AndroidKeyStore
          +
          +
          • +
        + + + +
          +
        • +

          retrieveKeyAndroidM

          +
          private static javax.crypto.SecretKey retrieveKeyAndroidM(java.lang.String alias)
          +
          Retrieve the key from the AndroidKeyStore
          +
          +
          Parameters:
          +
          alias - the alias to use when storing the key
          +
          Returns:
          +
          the SecretKey, or null if not present
          +
          +
          • +
        + + + +
          +
        • +

          storeKeyAndroidM

          +
          public static boolean storeKeyAndroidM(java.lang.String alias,
+                                       javax.crypto.SecretKey secretKey,
+                                       boolean userAuthenticationRequired,
+                                       int userAuthenticationValiditySeconds)
          +
          Stores a SecretKey in the AndroidKeyStore. + This is only useful when the phone is upgraded + to Android.M, where an existing key was stored + outside of the AndroidKeyStore.
          +
          +
          Parameters:
          +
          alias - the alias to use if generated in AndroidKeyStore
          +
          secretKey - the key to store
          +
          userAuthenticationRequired - for Android.M+ require screen lock. Note, if inMemory is true, + this applies only to versions extracted from the AndroidKeyStore.
          +
          userAuthenticationValiditySeconds - sets the duration for which this key is authorized + to be used after the user is successfully authenticated.
          +
          +
          • +
        + + + +
          +
        • +

          storeKeyAndroidN

          +
          public static boolean storeKeyAndroidN(java.lang.String alias,
+                                       javax.crypto.SecretKey secretKey,
+                                       boolean userAuthenticationRequired,
+                                       int userAuthenticationValiditySeconds,
+                                       boolean invalidatedByBiometricEnrollment)
          +
          Stores a SecretKey in the AndroidKeyStore. + This is only useful when the phone is upgraded + to Android.M, where an existing key was stored + outside of the AndroidKeyStore.
          +
          +
          Parameters:
          +
          alias - the alias to use if generated in AndroidKeyStore
          +
          secretKey - the symmetric key to store
          +
          userAuthenticationRequired - for Android.M+ require screen lock. Note, if inMemory is true, + this applies only to versions extracted from the AndroidKeyStore.
          +
          userAuthenticationValiditySeconds - sets the duration for which this key is authorized + to be used after the user is successfully authenticated.
          +
          invalidatedByBiometricEnrollment - true/false for Android-N+: + if setUserAuthenticationRequired true, some Android M devices may disable + a key if a fingerprint is added. Setting this value to true ensures + the key is usable even if a fingerprint is added.
          +
          +
          • +
        + + + +
          +
        • +

          deleteKey

          +
          public static void deleteKey(java.lang.String alias)
          +
          This method deletes the given key from AndroidKeyStore
          +
          +
          Parameters:
          +
          alias - the alias of the key to delete
          +
          +
          • +
        + + + +
          +
        • +

          deleteKeyAndroidM

          +
          private static void deleteKeyAndroidM(java.lang.String alias)
          +
          This method deletes the given key from AndroidKeyStore
          +
          +
          Parameters:
          +
          alias - the alias of the key to delete
          +
          +
          • +
        + + + +
          +
        • +

          encrypt

          +
          public static byte[] encrypt(byte[] data,
+                             javax.crypto.SecretKey secretKey,
+                             java.lang.String key)
          +
          Encrypts the given data.
          +
          +
          Parameters:
          +
          data - the data to encrypt
          +
          secretKey - the symmetric key for encryption
          +
          key - Key to use to generate a secret key for MAC operation, can be key alias
          +
          Returns:
          +
          encrypted data as byte[]
          +
          +
          • +
        + + + +
          +
        • +

          decrypt

          +
          public static byte[] decrypt(byte[] encryptedData,
+                             javax.crypto.SecretKey secretKey,
+                             java.lang.String key)
          +
          Decrypt the given data.
          +
          +
          Parameters:
          +
          encryptedData - data to be decrypted
          +
          secretKey - the symmetric key for decryption
          +
          key - Key to use to generate a secret key for MAC operation, can be key alias
          +
          Returns:
          +
          byte[] of decrypted data
          +
          +
          • +
        + + + +
          +
        • +

          computeMac

          +
          private static byte[] computeMac(java.lang.String key,
+                                 byte[] cipherText)
          +
          Computes the mac signature for the encrypted array
          +
          +
          Parameters:
          +
          key - Key to use to generate a secret key for MAC operation
          +
          cipherText - the data for which the signature has to be calculated
          +
          +
          • +
        + + + +
          +
        • +

          concatArrays

          +
          private static byte[] concatArrays(byte[] mac,
+                                   byte[] iv,
+                                   byte[] cipherText)
          +
          Combine the mac,iv and encrypted data arrays into one array
          +
          +
          Parameters:
          +
          mac -
          +
          iv -
          +
          cipherText -
          +
          Returns:
          +
          Combined mac, iv and encrypted data arrays.
          +
          +
          • +
        + + + +
          +
        • +

          getArraySubset

          +
          private static byte[] getArraySubset(byte[] array,
+                                     int start,
+                                     int length)
          +
          • +
        + + + +
          +
        • +

          destroyKey

          +
          private static void destroyKey(javax.crypto.SecretKey key)
          +
          Destroys the ephemeral key, in this case the Secret key generated for MAC, if the key implements Destroyable
          +
          +
          Parameters:
          +
          key -
          +
          +
          • +
        + + + +
          +
        • +

          checkDeleteKeys

          +
          private static void checkDeleteKeys(java.lang.String alias,
+                                    java.lang.Exception e)
          +
          If there is an exception with user not authenticated, delete the key
          +
          +
          Parameters:
          +
          alias - the name of the key
          +
          e - the exception
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/package-frame.html new file mode 100644 index 00000000..22044163 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/package-frame.html @@ -0,0 +1,31 @@ + + + + + +com.ca.mas.core.util + + + + + +

    com.ca.mas.core.util

    +
    +

    Interfaces

    + +

    Classes

    + +
    + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/package-summary.html new file mode 100644 index 00000000..981a4136 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/package-summary.html @@ -0,0 +1,191 @@ + + + + + +com.ca.mas.core.util + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package com.ca.mas.core.util

    +
    +
    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/package-tree.html new file mode 100644 index 00000000..5a41b510 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/core/util/package-tree.html @@ -0,0 +1,146 @@ + + + + + +com.ca.mas.core.util Class Hierarchy + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package com.ca.mas.core.util

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +

    Interface Hierarchy

    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/BuildConfig.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/BuildConfig.html new file mode 100644 index 00000000..6cbf1dfc --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/BuildConfig.html @@ -0,0 +1,356 @@ + + + + + +BuildConfig + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Class BuildConfig

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.foundation.BuildConfig
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public final class BuildConfig
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        static java.lang.StringAPPLICATION_ID 
        static java.lang.StringBUILD_TYPE 
        static booleanDEBUG 
        static java.lang.StringFLAVOR 
        static intVERSION_CODE 
        static java.lang.StringVERSION_NAME 
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        BuildConfig() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          BuildConfig

          +
          public BuildConfig()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/Device.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/Device.html index c9cd39ac..e7acf883 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/Device.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/Device.html @@ -2,9 +2,9 @@ - -Device (mas-foundation API) - + +Device + @@ -12,7 +12,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Class Extension

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.foundation.Extension
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class Extension
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ModifierConstructor and Description
        private Extension() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        private static <T> TgetDefaultImpl(java.lang.Class<T> tClass) 
        (package private) static voidinject(java.lang.Object instance) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Extension

          +
          private Extension()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDefaultImpl

          +
          private static <T> T getDefaultImpl(java.lang.Class<T> tClass)
          +
          • +
        + + + +
          +
        • +

          inject

          +
          static void inject(java.lang.Object instance)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/FoundationConsts.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/FoundationConsts.html new file mode 100644 index 00000000..a60de876 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/FoundationConsts.html @@ -0,0 +1,979 @@ + + + + + +FoundationConsts + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Class FoundationConsts

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.foundation.FoundationConsts
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      IdentityConsts, MessagingConsts
      +
      +
      +
      +
      public class FoundationConsts
+extends java.lang.Object
      +

      FoundationConsts contains the base constants used by any classes in the hierarchy. The nature of these constants is + intentianally general and is limited to basic timeout, network constants, and character constants that could potentially be + used anywhere in the SDK.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/Internal.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/Internal.html new file mode 100644 index 00000000..9d4895d8 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/Internal.html @@ -0,0 +1,162 @@ + + + + + +Internal + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Field | 
      • +
    • Required | 
      • +
    • Optional
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Element
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Annotation Type Internal

    +
    +
    +
    +
      +
    • +
      +
      +
      @Retention(value=RUNTIME)
+public @interface Internal
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Field | 
      • +
    • Required | 
      • +
    • Optional
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Element
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MAS.RequestCancelledException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MAS.RequestCancelledException.html index bdc590a0..ff77a4d8 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MAS.RequestCancelledException.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MAS.RequestCancelledException.html @@ -2,9 +2,9 @@ - -MAS.RequestCancelledException (mas-foundation API) - + +MAS.RequestCancelledException + @@ -12,7 +12,7 @@ @@ -12,13 +12,13 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,13 +12,13 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,13 +12,13 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ - - - - - -
    - - -
    Skip navigation links
    - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.ca.mas.foundation
    -

    Class MASMultiFactorAuthenticator<T extends MASMultiFactorHandler>

    -
    -
    -
      -
    • java.lang.Object
      • -
    • -
        -
      • com.ca.mas.foundation.MASMultiFactorAuthenticator<T>
        • -
      -
      • -
    -
    - -
    -
    -
      -
    • - - - -
        -
      • - - -

        Method Summary

        - - - - - - - - - - - - - - - - - - -
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethod and Description
        abstract TgetMultiFactorHandler(long requestId, - MASRequest request, - MASResponse<?> response) -
        Determines whether the custom MFA object can or will handle flow based on the response of the original request.
        -
        booleanintercept(long requestId, - MASRequest originalRequest, - android.os.Bundle requestExtra, - MASResponse<?> response) 
        protected abstract voidonMultiFactorAuthenticationRequest(android.content.Context context, - MASRequest originalRequest, - MASResponse<?> response, - T handler) -
        The method will be triggered when MASFoundation detects that the custom MFA class is responsible to handle MFA flow.
        -
        -
          -
        • - - -

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        - - - -
          -
        • -

          MASMultiFactorAuthenticator

          -
          public MASMultiFactorAuthenticator()
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getMultiFactorHandler

          -
          public abstract T getMultiFactorHandler(long requestId,
-                                        MASRequest request,
-                                        MASResponse<?> response)
          -
          Determines whether the custom MFA object can or will handle flow based on the response of the original request. - + The method will only be triggered when the original request failed, and the original request is not one of MAG/OTK's system endpoints.
          -
          -
          Parameters:
          -
          requestId - The request ID which identify the request ID which is pending for Multi-factor authentication
          -
          request - The original request that may trigger the multi-factor authentication.
          -
          response - The API Response
          -
          Returns:
          -
          If the custom MFA class can or will handle the MFA flow based on the error codes, or response of the request, - the method should return MASMultiFactorHandler class. - If null is returned from the method, the original request will deliver the result as it was..
          -
          -
          • -
        - - - - - -
          -
        • -

          onMultiFactorAuthenticationRequest

          -
          protected abstract void onMultiFactorAuthenticationRequest(android.content.Context context,
-                                                           MASRequest originalRequest,
-                                                           MASResponse<?> response,
-                                                           T handler)
          -
          The method will be triggered when MASFoundation detects that the custom MFA class is responsible to handle MFA flow. - MASMultiFactorHandler, step up authentication is required for this API request.
          -
          -
          Parameters:
          -
          context - The current Activity Context
          -
          originalRequest - The original request that may trigger the multi-factor authentication.
          -
          handler - To handle and provide more information required for step up authentication.
          -
          -
          • -
        - - - -
          -
        • -

          intercept

          -
          public boolean intercept(long requestId,
-                         MASRequest originalRequest,
-                         android.os.Bundle requestExtra,
-                         MASResponse<?> response)
          -
          • -
        -
        • -
      -
      • -
    -
    -
    - - -
    - - -
    Skip navigation links
    - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASOtpAuthenticationHandler.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASOtpAuthenticationHandler.html index fa2c9ab5..cd838c96 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASOtpAuthenticationHandler.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASOtpAuthenticationHandler.html @@ -2,9 +2,9 @@ - -MASOtpAuthenticationHandler (mas-foundation API) - + +MASOtpAuthenticationHandler + @@ -12,7 +12,7 @@ - - - - - -
    - - -
    Skip navigation links
    - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - -
    -
    com.ca.mas.foundation
    -

    Class MASOtpMultiFactorAuthenticator

    -
    -
    - -
    - -
    -
    - -
    -
    -
      -
    • - -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          MASOtpMultiFactorAuthenticator

          -
          public MASOtpMultiFactorAuthenticator()
          -
          • -
        -
        • -
      - -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          getMultiFactorHandler

          -
          public MASOtpAuthenticationHandler getMultiFactorHandler(long requestId,
-                                                         MASRequest request,
-                                                         MASResponse<?> response)
          -
          Description copied from class: MASMultiFactorAuthenticator
          -
          Determines whether the custom MFA object can or will handle flow based on the response of the original request. - + The method will only be triggered when the original request failed, and the original request is not one of MAG/OTK's system endpoints.
          -
          -
          Specified by:
          -
          getMultiFactorHandler in class MASMultiFactorAuthenticator<MASOtpAuthenticationHandler>
          -
          Parameters:
          -
          requestId - The request ID which identify the request ID which is pending for Multi-factor authentication
          -
          request - The original request that may trigger the multi-factor authentication.
          -
          response - The API Response
          -
          Returns:
          -
          If the custom MFA class can or will handle the MFA flow based on the error codes, or response of the request, - the method should return MASMultiFactorHandler class. - If null is returned from the method, the original request will deliver the result as it was..
          -
          -
          • -
        - - - - -
        • -
      -
      • -
    -
    -
    - - -
    - - -
    Skip navigation links
    - - - - -
    -
    - - - -
    - -
    -
    -
      -
    • Summary: 
      • -
    • Nested | 
      • -
    • Field | 
      • -
    • Constr | 
      • -
    • Method
      • -
    - -
    - - -
    - - - diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASRequest.MASRequestBuilder.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASRequest.MASRequestBuilder.html index 608ddef2..b9b26f7f 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASRequest.MASRequestBuilder.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASRequest.MASRequestBuilder.html @@ -2,9 +2,9 @@ - -MASRequest.MASRequestBuilder (mas-foundation API) - + +MASRequest.MASRequestBuilder + @@ -12,13 +12,13 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Interface MASTransformable

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          populate

          +
          void populate(@NonNull
+              org.json.JSONObject jobj)
+       throws org.json.JSONException
          +
          Description: +

          Populates the implementing class with the contents of the JSONObject. + A SCIM response contains a JSONObject with a defined structure, but much of the data could + be missing from the response, such as unpopulated fields, etc. Implementers need to determine + what is available.

          + Internal use only.
          +
          +
          Parameters:
          +
          jobj - is the non-null JSON response from SCIM.
          +
          Throws:
          +
          org.json.JSONException - is thrown when the JSONObject is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getAsJSONObject

          +
          org.json.JSONObject getAsJSONObject()
+                             throws org.json.JSONException
          +
          Description: +

          This method takes the implementing entity and transforms its properties into a JSON document. + This is the reverse of the above populate method.

          + Internal use only.
          +
          +
          Returns:
          +
          JSONObject - a valid JSON document representation of the entity.
          +
          Throws:
          +
          org.json.JSONException - - if any invalid components are encountered.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASUser.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASUser.html index 9a7e2ca0..6f7c3071 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASUser.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/MASUser.html @@ -2,9 +2,9 @@ - -MASUser (mas-foundation API) - + +MASUser + @@ -12,13 +12,13 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Class R.array

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.foundation.R.array
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      R
      +
      +
      +
      +
      public static final class R.array
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        static intscim_operators 
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        array() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          scim_operators

          +
          public static int scim_operators
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          array

          +
          public array()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.drawable.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.drawable.html new file mode 100644 index 00000000..898e9683 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.drawable.html @@ -0,0 +1,275 @@ + + + + + +R.drawable + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Class R.drawable

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.foundation.R.drawable
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      R
      +
      +
      +
      +
      public static final class R.drawable
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        static intca_logo 
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        drawable() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          ca_logo

          +
          public static int ca_logo
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          drawable

          +
          public drawable()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.html new file mode 100644 index 00000000..96f1d162 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.html @@ -0,0 +1,270 @@ + + + + + +R + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Class R

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.foundation.R
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public final class R
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClass and Description
        static class R.array 
        static class R.drawable 
        static class R.raw 
        static class R.string 
        static class R.xml 
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        R() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          R

          +
          public R()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.raw.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.raw.html new file mode 100644 index 00000000..ddc207dc --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.raw.html @@ -0,0 +1,275 @@ + + + + + +R.raw + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Class R.raw

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.foundation.R.raw
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      R
      +
      +
      +
      +
      public static final class R.raw
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        static intormlite_config 
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        raw() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          ormlite_config

          +
          public static int ormlite_config
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          raw

          +
          public raw()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.string.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.string.html new file mode 100644 index 00000000..487a7335 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.string.html @@ -0,0 +1,574 @@ + + + + + +R.string + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Class R.string

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.foundation.R.string
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      R
      +
      +
      +
      +
      public static final class R.string
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          acc_name

          +
          public static int acc_name
          +
          • +
        + + + +
          +
        • +

          app_name

          +
          public static int app_name
          +
          • +
        + + + +
          +
        • +

          attempting_to_connect

          +
          public static int attempting_to_connect
          +
          • +
        + + + +
          +
        • +

          client_already_connected

          +
          public static int client_already_connected
          +
          • +
        + + + +
          +
        • +

          client_already_disconnected

          +
          public static int client_already_disconnected
          +
          • +
        + + + +
          +
        • +

          connect_error

          +
          public static int connect_error
          +
          • +
        + + + +
          +
        • +

          connected

          +
          public static int connected
          +
          • +
        + + + +
          +
        • +

          connection_attempt

          +
          public static int connection_attempt
          +
          • +
        + + + +
          +
        • +

          connection_lost

          +
          public static int connection_lost
          +
          • +
        + + + +
          +
        • +

          could_not_connect

          +
          public static int could_not_connect
          +
          • +
        + + + +
          +
        • +

          could_not_disconnect

          +
          public static int could_not_disconnect
          +
          • +
        + + + +
          +
        • +

          could_not_publish

          +
          public static int could_not_publish
          +
          • +
        + + + +
          +
        • +

          could_not_subscribe

          +
          public static int could_not_subscribe
          +
          • +
        + + + +
          +
        • +

          could_not_unsubscribe

          +
          public static int could_not_unsubscribe
          +
          • +
        + + + +
          +
        • +

          delivery_failed

          +
          public static int delivery_failed
          +
          • +
        + + + +
          +
        • +

          delivery_succeeded

          +
          public static int delivery_succeeded
          +
          • +
        + + + +
          +
        • +

          disconnected

          +
          public static int disconnected
          +
          • +
        + + + +
          +
        • +

          login_not_connected_error

          +
          public static int login_not_connected_error
          +
          • +
        + + + +
          +
        • +

          published

          +
          public static int published
          +
          • +
        + + + +
          +
        • +

          resources

          +
          public static int resources
          +
          • +
        + + + +
          +
        • +

          subscribe_success

          +
          public static int subscribe_success
          +
          • +
        + + + +
          +
        • +

          subscribed

          +
          public static int subscribed
          +
          • +
        + + + +
          +
        • +

          unsubscribed

          +
          public static int unsubscribed
          +
          • +
        + + + +
          +
        • +

          uri_create_failed

          +
          public static int uri_create_failed
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          string

          +
          public string()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.xml.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.xml.html new file mode 100644 index 00000000..5253d122 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/R.xml.html @@ -0,0 +1,301 @@ + + + + + +R.xml + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Class R.xml

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.foundation.R.xml
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      R
      +
      +
      +
      +
      public static final class R.xml
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        xml() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          massharedauthenticator

          +
          public static int massharedauthenticator
          +
          • +
        + + + +
          +
        • +

          mastest

          +
          public static int mastest
          +
          • +
        + + + +
          +
        • +

          prefs

          +
          public static int prefs
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          xml

          +
          public xml()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/UserRepository.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/UserRepository.html new file mode 100644 index 00000000..68bd82b1 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/UserRepository.html @@ -0,0 +1,230 @@ + + + + + +UserRepository + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Interface UserRepository

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      UserInfoRepository
      +
      +
      +
      +
      public interface UserRepository
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCurrentUser

          +
          void getCurrentUser(MASCallback<MASUser> result)
          +
          Retrieve the user profile.
          +
          +
          Parameters:
          +
          result - Scim user profile.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/Xamarin.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/Xamarin.html new file mode 100644 index 00000000..7c51692d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/Xamarin.html @@ -0,0 +1,218 @@ + + + + + +Xamarin + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Field | 
      • +
    • Required | 
      • +
    • Optional
      • +
    + +
    + + +
    + + +
    +
    com.ca.mas.foundation
    +

    Annotation Type Xamarin

    +
    +
    +
    +
      +
    • +
      +
      +
      @Retention(value=SOURCE)
+public @interface Xamarin
      +
      Indicate this class or method is required for Xarmarin binding
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Optional Element Summary

        + + + + + + + + + + +
        Optional Elements 
        Modifier and TypeOptional Element and Description
        java.lang.Stringvalue +
        Defines the reason why we need this for binding
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Element Detail

        + + + +
          +
        • +

          value

          +
          public abstract java.lang.String value
          +
          Defines the reason why we need this for binding
          +
          +
          Default:
          +
          ""
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Field | 
      • +
    • Required | 
      • +
    • Optional
      • +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/auth/MASApplication.MASApplicationLauncher.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/auth/MASApplication.MASApplicationLauncher.html index ab383626..3c623389 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/auth/MASApplication.MASApplicationLauncher.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/auth/MASApplication.MASApplicationLauncher.html @@ -2,9 +2,9 @@ - -MASApplication.MASApplicationLauncher (mas-foundation API) - + +MASApplication.MASApplicationLauncher + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -20,8 +20,10 @@

    Interfaces

    Classes

    • MASApplication
      • +
    • MASApplication.ImageFetcher
    • MASApplication.MASApplicationLauncher
    • MASAuthenticationProvider
      • +
    • MASAuthenticationProvider.MagTask
    • MASAuthenticationProviders
    • MASProximityLoginBLE
    • MASProximityLoginBLEPeripheralListener
      • diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/auth/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/auth/package-summary.html index d2cdb363..4318531b 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/auth/package-summary.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/auth/package-summary.html @@ -2,9 +2,9 @@ - -com.ca.mas.foundation.auth (mas-foundation API) - + +com.ca.mas.foundation.auth + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
      + + +
      Skip navigation links
      + + + + +
      +
      +
        +
      • Prev Class
        • +
      • Next Class
        • +
      + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + +
      +
      com.ca.mas.foundation.notify
      +

      Class Callback

      +
      +
      +
        +
      • java.lang.Object
        • +
      • +
          +
        • com.ca.mas.foundation.notify.Callback
          • +
        +
        • +
      +
      +
        +
      • +
        +
        +
        public class Callback
+extends java.lang.Object
        +
        • +
      +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Summary

          + + + + + + + + +
          Constructors 
          Constructor and Description
          Callback() 
          +
          • +
        + + +
        • +
      +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            Callback

            +
            public Callback()
            +
            • +
          +
          • +
        + +
          +
        • + + +

          Method Detail

          + + + + + +
            +
          • +

            onSuccess

            +
            public static <T> void onSuccess(MASCallback<T> callback,
+                                 T value)
            +
            • +
          + + + +
            +
          • +

            onError

            +
            public static void onError(MASCallback callback,
+                           java.lang.Throwable t)
            +
            • +
          + + + +
            +
          • +

            transform

            +
            private static MASException transform(java.lang.Throwable t)
            +
            • +
          + + + +
            +
          • +

            getHandler

            +
            public static android.os.Handler getHandler(MASCallback callback)
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + +
      Skip navigation links
      + + + + +
      +
      +
        +
      • Prev Class
        • +
      • Next Class
        • +
      + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      + +
      + + +
      + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/notify/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/notify/package-frame.html new file mode 100644 index 00000000..27728d84 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/notify/package-frame.html @@ -0,0 +1,20 @@ + + + + + +com.ca.mas.foundation.notify + + + + + +

      com.ca.mas.foundation.notify

      +
      +

      Classes

      + +
      + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/notify/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/notify/package-summary.html new file mode 100644 index 00000000..2c11e986 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/notify/package-summary.html @@ -0,0 +1,140 @@ + + + + + +com.ca.mas.foundation.notify + + + + + + + + +
      + + +
      Skip navigation links
      + + + + +
      +
      + + + +
      + +
      + + +
      + +
      +

      Package com.ca.mas.foundation.notify

      +
      +
      +
        +
      • + + + + + + + + + + + + +
        Class Summary 
        ClassDescription
        Callback 
        +
        • +
      +
      + +
      + + +
      Skip navigation links
      + + + + +
      +
      + + + +
      + +
      + + +
      + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/notify/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/notify/package-tree.html new file mode 100644 index 00000000..d037002a --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/notify/package-tree.html @@ -0,0 +1,135 @@ + + + + + +com.ca.mas.foundation.notify Class Hierarchy + + + + + + + + +
      + + +
      Skip navigation links
      + + + + +
      +
      + + + +
      + +
      + + +
      + +
      +

      Hierarchy For Package com.ca.mas.foundation.notify

      +Package Hierarchies: + +
      +
      +

      Class Hierarchy

      +
        +
      • java.lang.Object +
          +
        • com.ca.mas.foundation.notify.Callback
          • +
        +
        • +
      +
      + +
      + + +
      Skip navigation links
      + + + + +
      +
      + + + +
      + +
      + + +
      + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/package-frame.html index a918a5e9..c3fc71fd 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/package-frame.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/package-frame.html @@ -2,9 +2,9 @@ - -com.ca.mas.foundation (mas-foundation API) - + +com.ca.mas.foundation + @@ -22,9 +22,16 @@

      Interfaces

    • MASRequest
    • MASResponse
    • MASSecurityConfiguration
      • +
    • MASTransformable
      • +
    • UserRepository

    Classes

    Enums

    Exceptions

    Annotation Types

    diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/package-summary.html index 35a98142..16f6123f 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/package-summary.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/foundation/package-summary.html @@ -2,9 +2,9 @@ - -com.ca.mas.foundation (mas-foundation API) - + +com.ca.mas.foundation + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.identity
    +

    Enum ScimIdentifiable.ResourceType

    +
    +
    + +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum Constant and Description
        Application 
        Device 
        None 
        User 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static ScimIdentifiable.ResourceTypevalueOf(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static ScimIdentifiable.ResourceType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ScimIdentifiable.ResourceType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ScimIdentifiable.ResourceType c : ScimIdentifiable.ResourceType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ScimIdentifiable.ResourceType valueOf(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/ScimIdentifiable.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/ScimIdentifiable.html new file mode 100644 index 00000000..c813e49d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/ScimIdentifiable.html @@ -0,0 +1,323 @@ + + + + + +ScimIdentifiable + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.identity
    +

    Interface ScimIdentifiable

    +
    +
    +
    +
      +
    • +
      +
      All Known Subinterfaces:
      +
      ScimUser
      +
      +
      +
      All Known Implementing Classes:
      +
      MASUser, User
      +
      +
      +
      +
      public interface ScimIdentifiable
      +

      ScimIdentifiable is an interface that should be implemented by any class that requires uniqueness within the system. A ScimIdentifiable + object can be a user, a message, a device, or any other entity that needs to be managed and categorized. The id value must be unique + within the system regardless of where this unique value originates. This could be a unique key in a database, a GUID generated in the application + using the MAS SDK, or a timestamp that is granular enough to guarantee uniqueness. The displayName is unconstrained and can be anything, or null. + The externalId is added to satisfy the scim core schema and the + scim protocol specification. +

      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeInterface and Description
        static class ScimIdentifiable.ResourceType +
        Description: These ResourceTypes are base objects within the system.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethod and Description
        longgetCardinality() +
        Description: Get the previous set value of the default value for the long data type (0).
        +
        java.lang.StringgetDisplayName() +
        Description: The string value set by the application developer.
        +
        java.lang.StringgetExternalId() +
        Description: The value returned is based on the scim core schema.
        +
        java.lang.StringgetId() +
        Description: Return the unique id that has been previously set through the call to setId.
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getId

          +
          java.lang.String getId()
          +
          Description: Return the unique id that has been previously set through the call to setId. If no value has been + set for the id then this value could be null.
          +
          +
          Returns:
          +
          String representing the unique id. Can be null.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getDisplayName

          +
          java.lang.String getDisplayName()
          +
          Description: The string value set by the application developer.
          +
          +
          Returns:
          +
          String the free-form display name. Can be null.
          +
          +
          • +
        + + + +
          +
        • +

          getCardinality

          +
          long getCardinality()
          +
          Description: Get the previous set value of the default value for the long data type (0).
          +
          +
          Returns:
          +
          long the value that is used for ordering this ScimIdentifiable
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/Attribute.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/Attribute.html new file mode 100644 index 00000000..15eebf08 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/Attribute.html @@ -0,0 +1,602 @@ + + + + + +Attribute + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.identity.common
    +

    Class Attribute

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.identity.common.Attribute
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class Attribute
+extends java.lang.Object
      +

      The Attribute class represents the SCIM + attribute data model and is used to describe an attribute available in the + SCIM server implementation.

      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        Attribute() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        java.lang.StringgetDescription() +
        Description: Getter.
        +
        java.lang.StringgetMutability() +
        Description: Getter.
        +
        java.lang.StringgetName() +
        Description: Getter.
        +
        java.lang.StringgetReturned() +
        Description: Getter.
        +
        java.lang.StringgetType() +
        Description: Getter.
        +
        java.lang.StringgetUniqueness() +
        Description: Getter.
        +
        booleanisCaseExact() +
        Description: Predicate.
        +
        booleanisMultiValued() +
        Description: Predicate.
        +
        booleanisRequired() +
        Description: Predicate.
        +
        voidpopulate(org.json.JSONObject jobj) +
        Description: Populate the Attribute from the JSON object retrieved from the server.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          mName

          +
          private java.lang.String mName
          +
          • +
        + + + +
          +
        • +

          mType

          +
          private java.lang.String mType
          +
          • +
        + + + +
          +
        • +

          mIsMultiValued

          +
          private boolean mIsMultiValued
          +
          • +
        + + + +
          +
        • +

          mDescription

          +
          private java.lang.String mDescription
          +
          • +
        + + + +
          +
        • +

          mIsRequired

          +
          private boolean mIsRequired
          +
          • +
        + + + +
          +
        • +

          mIsCaseExact

          +
          private boolean mIsCaseExact
          +
          • +
        + + + +
          +
        • +

          mMutability

          +
          private java.lang.String mMutability
          +
          • +
        + + + +
          +
        • +

          mReturned

          +
          private java.lang.String mReturned
          +
          • +
        + + + +
          +
        • +

          mUniqueness

          +
          private java.lang.String mUniqueness
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Attribute

          +
          public Attribute()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          populate

          +
          public void populate(org.json.JSONObject jobj)
+              throws org.json.JSONException
          +
          Description: Populate the Attribute from the JSON object retrieved from the server.
          +
          +
          Parameters:
          +
          jobj - the JSONObject
          +
          Throws:
          +
          org.json.JSONException - if the JSON file cannot be processed.
          +
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          public java.lang.String getDescription()
          +
          Description: Getter. See description
          +
          +
          Returns:
          +
          String the description of the attribute.
          +
          +
          • +
        + + + +
          +
        • +

          isCaseExact

          +
          public boolean isCaseExact()
          +
          Description: Predicate. See caseExact.
          +
          +
          Returns:
          +
          true or false.
          +
          +
          • +
        + + + +
          +
        • +

          isMultiValued

          +
          public boolean isMultiValued()
          +
          Description: Predicate. See multiValue
          +
          +
          Returns:
          +
          true or false.
          +
          +
          • +
        + + + +
          +
        • +

          isRequired

          +
          public boolean isRequired()
          +
          Description: Predicate. See required.
          +
          +
          Returns:
          +
          true or false. Is "false" by default (i.e., not REQUIRED).
          +
          +
          • +
        + + + +
          +
        • +

          getMutability

          +
          public java.lang.String getMutability()
          +
          Description: Getter. See mutability
          +
          +
          Returns:
          +
          String is "readWrite" (i.e., modifiable).
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description: Getter. See name.
          +
          +
          Returns:
          +
          String the name of the attribute.
          +
          +
          • +
        + + + +
          +
        • +

          getReturned

          +
          public java.lang.String getReturned()
          +
          Description: Getter. See returned.
          +
          +
          Returns:
          +
          String which is is "default" (the attribute value is returned by default)
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public java.lang.String getType()
          +
          Description: Getter. See type.
          +
          +
          Returns:
          +
          String is "string".
          +
          +
          • +
        + + + +
          +
        • +

          getUniqueness

          +
          public java.lang.String getUniqueness()
          +
          Description: Getter. See uniqueness.
          +
          +
          Returns:
          +
          String is "none" (has no uniqueness enforced).
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/Attributes.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/Attributes.html new file mode 100644 index 00000000..d4787041 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/Attributes.html @@ -0,0 +1,467 @@ + + + + + +Attributes + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.identity.common
    +

    Class Attributes

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.identity.common.Attributes
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      MASTransformable
      +
      +
      +
      Direct Known Subclasses:
      +
      GroupAttributes, UserAttributes
      +
      +
      +
      +
      public abstract class Attributes
+extends java.lang.Object
+implements MASTransformable
      +

      Attributes is the base class used to hold specific attributes that are defined by the implementing, or concrete class. These + attributes are the returned values from a SCIM SCHEMA call and contain the attributes supported by this SCIM impelentation on the server.

      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        protected java.util.List<java.lang.String>mAttributes 
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        Attributes() +
        No args constructor.
        +
        Attributes(java.util.List<java.lang.String> attributes) +
        Convenience constructor.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethod and Description
        voidclear(android.content.Context context) +
        Description: Calling this method will clear the shared prefences containing the attributes that had been previously written in a + call to 'saveAttributes'.
        +
        org.json.JSONObjectgetAsJSONObject() +
        Description:
        +
        java.util.List<java.lang.String>getAttributes() +
        Pre-Conditions: None.
        + Description: Return the list of attributes that exist on the SCIM endpoint.
        +
        protected abstract java.lang.StringgetKey() 
        abstract voidpopulate(org.json.JSONObject jobj) +
        Description:
        +
        voidsave(android.content.Context context) +
        Description: This method takes the current attributes, contained in the attributes list, and saves them to the Android + shared preferences.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          mAttributes

          +
          protected java.util.List<java.lang.String> mAttributes
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Attributes

          +
          public Attributes()
          +
          No args constructor.
          +
          • +
        + + + +
          +
        • +

          Attributes

          +
          public Attributes(java.util.List<java.lang.String> attributes)
          +
          Convenience constructor.
          +
          +
          Parameters:
          +
          attributes -
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          populate

          +
          public abstract void populate(@NonNull
+                              org.json.JSONObject jobj)
+                       throws org.json.JSONException
          +
          Description copied from interface: MASTransformable
          +
          Description: +

          Populates the implementing class with the contents of the JSONObject. + A SCIM response contains a JSONObject with a defined structure, but much of the data could + be missing from the response, such as unpopulated fields, etc. Implementers need to determine + what is available.

          + Internal use only.
          +
          +
          Specified by:
          +
          populate in interface MASTransformable
          +
          Parameters:
          +
          jobj - is the non-null JSON response from SCIM.
          +
          Throws:
          +
          org.json.JSONException - is thrown when the JSONObject is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getAsJSONObject

          +
          public org.json.JSONObject getAsJSONObject()
+                                    throws org.json.JSONException
          +
          Description copied from interface: MASTransformable
          +
          Description: +

          This method takes the implementing entity and transforms its properties into a JSON document. + This is the reverse of the above populate method.

          + Internal use only.
          +
          +
          Specified by:
          +
          getAsJSONObject in interface MASTransformable
          +
          Returns:
          +
          JSONObject - a valid JSON document representation of the entity.
          +
          Throws:
          +
          org.json.JSONException - - if any invalid components are encountered.
          +
          +
          • +
        + + + +
          +
        • +

          save

          +
          public void save(android.content.Context context)
          +
          Description: This method takes the current attributes, contained in the attributes list, and saves them to the Android + shared preferences. This is done as an optimization so that every request for the attributes does not result in a network operation.
          +
          +
          Parameters:
          +
          context -
          +
          +
          • +
        + + + +
          +
        • +

          clear

          +
          public void clear(android.content.Context context)
          +
          Description: Calling this method will clear the shared prefences containing the attributes that had been previously written in a + call to 'saveAttributes'. This method can be used to force a network operation on a subsequent to getAttributes.
          +
          +
          Parameters:
          +
          context -
          +
          +
          • +
        + + + +
          +
        • +

          getAttributes

          +
          public java.util.List<java.lang.String> getAttributes()
          +
          Pre-Conditions: None.
          + Description: Return the list of attributes that exist on the SCIM endpoint. If the attributes are currently loaded into + the data structure then simply return the data structure. If not, then attempt to read them from the shared preferences. This value + could be null, and if it is, then a network operation must be performed to retrieve the attributes required.
          +
          +
          Returns:
          +
          List The list of SCIM endpoints
          +
          +
          • +
        + + + +
          +
        • +

          getKey

          +
          protected abstract java.lang.String getKey()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/MASFilteredRequest.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/MASFilteredRequest.html index d0d3b4b2..21210532 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/MASFilteredRequest.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/MASFilteredRequest.html @@ -2,9 +2,9 @@ - -MASFilteredRequest (mas-foundation API) - + +MASFilteredRequest + @@ -12,13 +12,13 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -18,6 +18,9 @@

    Interfaces

    Classes

    Enums

    diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/package-summary.html index 70167896..2b0f359d 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/package-summary.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/common/package-summary.html @@ -2,9 +2,9 @@ - -com.ca.mas.identity.common (mas-foundation API) - + +com.ca.mas.identity.common + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.identity.group
    +

    Class GroupAttributes

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      MASTransformable
      +
      +
      +
      +
      public class GroupAttributes
+extends Attributes
      +

      GroupAttributes is the specialization of the Attributes class and deals specifically with SCIM groups. GroupAttributes is a + MASTransformable implementer that is able to populate itself.

      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        GroupAttributes() +
        Description: Default no-args constructor.
        +
        +
        • +
      + + +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          GroupAttributes

          +
          public GroupAttributes()
          +
          Description: Default no-args constructor.
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          populate

          +
          public void populate(@NonNull
+                     org.json.JSONObject jobj)
+              throws org.json.JSONException
          +
          Description copied from interface: MASTransformable
          +
          Description: +

          Populates the implementing class with the contents of the JSONObject. + A SCIM response contains a JSONObject with a defined structure, but much of the data could + be missing from the response, such as unpopulated fields, etc. Implementers need to determine + what is available.

          + Internal use only.
          +
          +
          Specified by:
          +
          populate in interface MASTransformable
          +
          Specified by:
          +
          populate in class Attributes
          +
          Parameters:
          +
          jobj - is the non-null JSON response from SCIM.
          +
          Throws:
          +
          org.json.JSONException - is thrown when the JSONObject is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getKey

          +
          protected java.lang.String getKey()
          +
          +
          Specified by:
          +
          getKey in class Attributes
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/group/MASGroupIdentity.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/group/MASGroupIdentity.html index 4e218ffd..aef877f7 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/group/MASGroupIdentity.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/group/MASGroupIdentity.html @@ -2,9 +2,9 @@ - -MASGroupIdentity (mas-foundation API) - + +MASGroupIdentity + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -18,6 +18,7 @@

    Interfaces

    Classes

    diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/group/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/group/package-summary.html index bdd8bd85..5152e68d 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/group/package-summary.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/group/package-summary.html @@ -2,9 +2,9 @@ - -com.ca.mas.identity.group (mas-foundation API) - + +com.ca.mas.identity.group + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + +

    com.ca.mas.identity

    +
    +

    Interfaces

    + +

    Enums

    + +
    + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/package-summary.html new file mode 100644 index 00000000..8ddd38f6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/package-summary.html @@ -0,0 +1,159 @@ + + + + + +com.ca.mas.identity + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package com.ca.mas.identity

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      ScimIdentifiable +
      ScimIdentifiable is an interface that should be implemented by any class that requires uniqueness within the system.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      ScimIdentifiable.ResourceType +
      Description: These ResourceTypes are base objects within the system.
      +
      +
      • +
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/package-tree.html new file mode 100644 index 00000000..65e859ad --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/package-tree.html @@ -0,0 +1,143 @@ + + + + + +com.ca.mas.identity Class Hierarchy + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package com.ca.mas.identity

    +Package Hierarchies: + +
    +
    +

    Interface Hierarchy

    + +

    Enum Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/IdentityBase.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/IdentityBase.html new file mode 100644 index 00000000..fcd9d11f --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/IdentityBase.html @@ -0,0 +1,434 @@ + + + + + +IdentityBase + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.identity.user
    +

    Class IdentityBase

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.identity.user.IdentityBase
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      MASTransformable
      +
      +
      +
      Direct Known Subclasses:
      +
      MASEmail, MASIms, MASPhone, MASPhoto
      +
      +
      +
      +
      public class IdentityBase
+extends java.lang.Object
+implements MASTransformable
      +

      IdentityBase is a MASTransformable class that is used to represent SCIM attributes that are share a common + description set. In particular, those SCIM representations that contain a type and a value.

      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        private java.lang.StringmType 
        private java.lang.StringmValue 
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        IdentityBase() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        org.json.JSONObjectgetAsJSONObject() +
        Description:
        +
        java.lang.StringgetType() +
        Description: Getter to return the type for this SCIM representation.
        +
        java.lang.StringgetValue() +
        Description: Getter to return the value for this SCIM representation.
        +
        voidpopulate(org.json.JSONObject jobj) +
        Description:
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          mType

          +
          private java.lang.String mType
          +
          • +
        + + + +
          +
        • +

          mValue

          +
          private java.lang.String mValue
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IdentityBase

          +
          public IdentityBase()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getType

          +
          public java.lang.String getType()
          +
          Description: Getter to return the type for this SCIM representation.
          +
          +
          Returns:
          +
          String - the type that is based on the implementing class' type and value context.
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public java.lang.String getValue()
          +
          Description: Getter to return the value for this SCIM representation.
          +
          +
          Returns:
          +
          String the value that is based on the implementing class' type and value context.
          +
          +
          • +
        + + + +
          +
        • +

          populate

          +
          public void populate(@NonNull
+                     org.json.JSONObject jobj)
+              throws org.json.JSONException
          +
          Description copied from interface: MASTransformable
          +
          Description: +

          Populates the implementing class with the contents of the JSONObject. + A SCIM response contains a JSONObject with a defined structure, but much of the data could + be missing from the response, such as unpopulated fields, etc. Implementers need to determine + what is available.

          + Internal use only.
          +
          +
          Specified by:
          +
          populate in interface MASTransformable
          +
          Parameters:
          +
          jobj - is the non-null JSON response from SCIM.
          +
          Throws:
          +
          org.json.JSONException - is thrown when the JSONObject is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getAsJSONObject

          +
          public org.json.JSONObject getAsJSONObject()
+                                    throws org.json.JSONException
          +
          Description copied from interface: MASTransformable
          +
          Description: +

          This method takes the implementing entity and transforms its properties into a JSON document. + This is the reverse of the above populate method.

          + Internal use only.
          +
          +
          Specified by:
          +
          getAsJSONObject in interface MASTransformable
          +
          Returns:
          +
          JSONObject - a valid JSON document representation of the entity.
          +
          Throws:
          +
          org.json.JSONException - - if any invalid components are encountered.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/MASAddress.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/MASAddress.html index e470ee2b..09d3f3e5 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/MASAddress.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/MASAddress.html @@ -2,9 +2,9 @@ - -MASAddress (mas-foundation API) - + +MASAddress + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.identity.user
    +

    Class User.X509Cert

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.identity.user.User.X509Cert
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        private java.lang.StringmValue 
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        X509Cert() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        org.json.JSONObjectgetAsJSONObject() +
        Description:
        +
        voidpopulate(org.json.JSONObject jobj) +
        Description:
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          mValue

          +
          private java.lang.String mValue
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          X509Cert

          +
          public X509Cert()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          populate

          +
          public void populate(@NonNull
+                     org.json.JSONObject jobj)
+              throws org.json.JSONException
          +
          Description copied from interface: MASTransformable
          +
          Description: +

          Populates the implementing class with the contents of the JSONObject. + A SCIM response contains a JSONObject with a defined structure, but much of the data could + be missing from the response, such as unpopulated fields, etc. Implementers need to determine + what is available.

          + Internal use only.
          +
          +
          Specified by:
          +
          populate in interface MASTransformable
          +
          Parameters:
          +
          jobj - is the non-null JSON response from SCIM.
          +
          Throws:
          +
          org.json.JSONException - is thrown when the JSONObject is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getAsJSONObject

          +
          public org.json.JSONObject getAsJSONObject()
+                                    throws org.json.JSONException
          +
          Description copied from interface: MASTransformable
          +
          Description: +

          This method takes the implementing entity and transforms its properties into a JSON document. + This is the reverse of the above populate method.

          + Internal use only.
          +
          +
          Specified by:
          +
          getAsJSONObject in interface MASTransformable
          +
          Returns:
          +
          JSONObject - a valid JSON document representation of the entity.
          +
          Throws:
          +
          org.json.JSONException - - if any invalid components are encountered.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/User.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/User.html new file mode 100644 index 00000000..becfaa76 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/User.html @@ -0,0 +1,1688 @@ + + + + + +User + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.identity.user
    +

    Class User

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          mId

          +
          protected java.lang.String mId
          +
          • +
        + + + +
          +
        • +

          mExternalId

          +
          private java.lang.String mExternalId
          +
          • +
        + + + +
          +
        • +

          mName

          +
          protected MASName mName
          +
          • +
        + + + +
          +
        • +

          mUserName

          +
          protected java.lang.String mUserName
          +
          • +
        + + + +
          +
        • +

          mNickName

          +
          private java.lang.String mNickName
          +
          • +
        + + + +
          +
        • +

          mDisplayName

          +
          private java.lang.String mDisplayName
          +
          • +
        + + + +
          +
        • +

          mProfileUrl

          +
          private java.lang.String mProfileUrl
          +
          • +
        + + + +
          +
        • +

          mUserType

          +
          private java.lang.String mUserType
          +
          • +
        + + + +
          +
        • +

          mTitle

          +
          private java.lang.String mTitle
          +
          • +
        + + + +
          +
        • +

          mPreferredLanguage

          +
          private java.lang.String mPreferredLanguage
          +
          • +
        + + + +
          +
        • +

          mLocale

          +
          private java.lang.String mLocale
          +
          • +
        + + + +
          +
        • +

          mTimeZone

          +
          private java.lang.String mTimeZone
          +
          • +
        + + + +
          +
        • +

          mIsActive

          +
          private boolean mIsActive
          +
          • +
        + + + +
          +
        • +

          mPassword

          +
          private java.lang.String mPassword
          +
          • +
        + + + +
          +
        • +

          mMeta

          +
          private MASMeta mMeta
          +
          • +
        + + + +
          +
        • +

          mCardinality

          +
          private long mCardinality
          +
          • +
        + + + +
          +
        • +

          mSource

          +
          private org.json.JSONObject mSource
          +
          • +
        + + + +
          +
        • +

          mAddressList

          +
          private final java.util.List<MASAddress> mAddressList
          +
          • +
        + + + +
          +
        • +

          mEmailList

          +
          private final java.util.List<MASEmail> mEmailList
          +
          • +
        + + + +
          +
        • +

          mPhoneList

          +
          private final java.util.List<MASPhone> mPhoneList
          +
          • +
        + + + +
          +
        • +

          mPhotoList

          +
          private final java.util.List<MASPhoto> mPhotoList
          +
          • +
        + + + +
          +
        • +

          mImsList

          +
          private final java.util.List<MASIms> mImsList
          +
          • +
        + + + +
          +
        • +

          mCertList

          +
          private final java.util.List<User.X509Cert> mCertList
          +
          • +
        + + + +
          +
        • +

          mGroupList

          +
          private final java.util.List<MASGroup> mGroupList
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          User

          +
          public User()
          +
          Description: No args constructor.
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          populate

          +
          public void populate(@NonNull
+                     org.json.JSONObject jsonObject)
+              throws org.json.JSONException
          +
          Description copied from interface: MASTransformable
          +
          Description: +

          Populates the implementing class with the contents of the JSONObject. + A SCIM response contains a JSONObject with a defined structure, but much of the data could + be missing from the response, such as unpopulated fields, etc. Implementers need to determine + what is available.

          + Internal use only.
          +
          +
          Parameters:
          +
          jsonObject - is the non-null JSON response from SCIM.
          +
          Throws:
          +
          org.json.JSONException - is thrown when the JSONObject is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getAsJSONObject

          +
          public org.json.JSONObject getAsJSONObject()
+                                    throws org.json.JSONException
          +
          Description copied from interface: MASTransformable
          +
          Description: +

          This method takes the implementing entity and transforms its properties into a JSON document. + This is the reverse of the above populate method.

          + Internal use only.
          +
          +
          Returns:
          +
          JSONObject - a valid JSON document representation of the entity.
          +
          Throws:
          +
          org.json.JSONException - - if any invalid components are encountered.
          +
          +
          • +
        + + + +
          +
        • +

          getId

          +
          public java.lang.String getId()
          +
          Description copied from interface: ScimIdentifiable
          +
          Description: Return the unique id that has been previously set through the call to setId. If no value has been + set for the id then this value could be null.
          +
          +
          Returns:
          +
          String representing the unique id. Can be null.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getDisplayName

          +
          public java.lang.String getDisplayName()
          +
          Description copied from interface: ScimIdentifiable
          +
          Description: The string value set by the application developer.
          +
          +
          Returns:
          +
          String the free-form display name. Can be null.
          +
          +
          • +
        + + + +
          +
        • +

          getCardinality

          +
          public long getCardinality()
          +
          Description copied from interface: ScimIdentifiable
          +
          Description: Get the previous set value of the default value for the long data type (0).
          +
          +
          Returns:
          +
          long the value that is used for ordering this ScimIdentifiable
          +
          +
          • +
        + + + +
          +
        • +

          getAddressList

          +
          public java.util.List<MASAddress> getAddressList()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of addresses
          +
          +
          Returns:
          +
          List<MASAddress> contains this user's addresses. This list could be null or empty.
          +
          +
          • +
        + + + +
          +
        • +

          getEmailList

          +
          public java.util.List<MASEmail> getEmailList()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of emails
          +
          +
          Returns:
          +
          List<User.Email> contains this user's emails. This list could be null or empty.
          +
          +
          • +
        + + + +
          +
        • +

          getPhoneList

          +
          public java.util.List<MASPhone> getPhoneList()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of phoneNumbers
          +
          +
          Returns:
          +
          List<User.Phone> contains this user's phone numbers. This list could be null or empty.
          +
          +
          • +
        + + + +
          +
        • +

          getImsList

          +
          public java.util.List<MASIms> getImsList()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of addresses
          +
          +
          Returns:
          +
          List<MASAddress> contains this user's instant messaging addresses. This list could be null or empty.
          +
          +
          • +
        + + + +
          +
        • +

          getPhotoList

          +
          public java.util.List<MASPhoto> getPhotoList()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of photos
          +
          +
          Returns:
          +
          List<User.Photo> contains this user's photos. This list could be null or empty.
          +
          +
          • +
        + + + +
          +
        • +

          getNickName

          +
          public java.lang.String getNickName()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of nickName
          +
          +
          Returns:
          +
          String representing this user's nickname. This attribute may contain white-space or be null.
          +
          +
          • +
        + + + +
          +
        • +

          getProfileUrl

          +
          public java.lang.String getProfileUrl()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of profileUrl
          +
          +
          Returns:
          +
          String representation of the user's profile URI. This attribute may contain white-space or be null.
          +
          +
          • +
        + + + +
          +
        • +

          getUserName

          +
          public java.lang.String getUserName()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of userName
          +
          +
          Returns:
          +
          String the case-sensitive, required attribute.
          +
          +
          • +
        + + + +
          +
        • +

          getUserType

          +
          public java.lang.String getUserType()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of userType
          +
          +
          Returns:
          +
          String representing the relationship between the organization and the user. This attribute may contain white-space or be null.
          +
          +
          • +
        + + + +
          +
        • +

          getTitle

          +
          public java.lang.String getTitle()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of title
          +
          +
          Returns:
          +
          String representing the user's title. This attribute may contain white-space or be null.
          +
          +
          • +
        + + + +
          +
        • +

          getPreferredLanguage

          +
          public java.lang.String getPreferredLanguage()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of preferredLanguage
          +
          +
          Returns:
          +
          String representing the user's preferred language. This attribute may contain white-space or be null.
          +
          +
          • +
        + + + +
          +
        • +

          getLocale

          +
          public java.lang.String getLocale()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of locale
          +
          +
          Returns:
          +
          String representing the user's locale. This attribute may contain white-space or be null.
          +
          +
          • +
        + + + +
          +
        • +

          getTimeZone

          +
          public java.lang.String getTimeZone()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of timezone
          +
          +
          Returns:
          +
          String representing the user's timezone. This attribute may be null.
          +
          +
          • +
        + + + +
          +
        • +

          isActive

          +
          public boolean isActive()
          +
          Description copied from interface: ScimUser
          +
          Description:See the SCIM definition of active
          +
          +
          Returns:
          +
          boolean representing whether the user is active. Will either be true or false (default).
          +
          +
          • +
        + + + +
          +
        • +

          getPassword

          +
          public java.lang.String getPassword()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of password
          +
          +
          Returns:
          +
          String representing the user's password. This attribute may be null.
          +
          +
          • +
        + + + +
          +
        • +

          getMeta

          +
          public MASMeta getMeta()
          +
          Description copied from interface: ScimUser
          +
          Description: See MASMeta.
          +
          +
          Returns:
          +
          The MASMeta item used to describe this user. It could be null.
          +
          +
          • +
        + + + +
          +
        • +

          getGroupList

          +
          public java.util.List<MASGroup> getGroupList()
          +
          Description copied from interface: ScimUser
          +
          Description: See the SCIM definition of groups
          +
          +
          Returns:
          +
          List<MASGroup> this user is a member of. This list could be null or empty.
          +
          +
          • +
        + + + + + + + + + + + + + + + +
          +
        • +

          getAccessToken

          +
          public java.lang.String getAccessToken()
          +
          +
          Specified by:
          +
          getAccessToken in class MASUser
          +
          Returns:
          +
          OAuth Access Token
          +
          +
          • +
        + + + +
          +
        • +

          getThumbnailImage

          +
          public android.graphics.Bitmap getThumbnailImage()
          +
          +
          Specified by:
          +
          getThumbnailImage in class MASUser
          +
          +
          • +
        + + + +
          +
        • +

          sendMessage

          +
          public void sendMessage(MASTopic topic,
+                        MASMessage message,
+                        MASCallback<java.lang.Void> callback)
          +
          Description copied from interface: MASMessenger
          +
          This method sends a message from the current user to a topic.
          +
          +
          Specified by:
          +
          sendMessage in interface MASMessenger
          +
          Specified by:
          +
          sendMessage in class MASUser
          +
          Parameters:
          +
          topic - The Topic to subscribe to.
          +
          message - The Message to be sent. Only MASMessage objects are supported.
          +
          callback - The Callback with either the Success or Error message.
          +
          +
          • +
        + + + +
          +
        • +

          sendMessage

          +
          public void sendMessage(MASMessage message,
+                        MASUser user,
+                        MASCallback<java.lang.Void> callback)
          +
          Description copied from interface: MASMessenger
          +
          This method sends a message from the current user to an existing user.
          +
          +
          Specified by:
          +
          sendMessage in interface MASMessenger
          +
          Specified by:
          +
          sendMessage in class MASUser
          +
          Parameters:
          +
          message - The Message to be sent.
          +
          user - The User to send the message to.
          +
          callback - The Callback with either the Success or Error message.
          +
          +
          • +
        + + + +
          +
        • +

          sendMessage

          +
          public void sendMessage(MASMessage message,
+                        MASUser user,
+                        java.lang.String topic,
+                        MASCallback<java.lang.Void> callback)
          +
          Description copied from interface: MASMessenger
          +
          This method sends a message from the current user to an existing user on a specified topic.
          +
          +
          Specified by:
          +
          sendMessage in interface MASMessenger
          +
          Specified by:
          +
          sendMessage in class MASUser
          +
          Parameters:
          +
          message - The Message to be sent.
          +
          user - The User to send the message to.
          +
          callback - The Callback with either the Success or the Error message.
          +
          +
          • +
        + + + +
          +
        • +

          sendMessage

          +
          public void sendMessage(MASMessage message,
+                        MASGroup group,
+                        MASCallback<java.lang.Void> callback)
          +
          Description copied from interface: MASMessenger
          +
          This method sends a message from the current user to an existing group.
          +
          +
          Specified by:
          +
          sendMessage in interface MASMessenger
          +
          Specified by:
          +
          sendMessage in class MASUser
          +
          Parameters:
          +
          message - The Message to be sent.
          +
          group - The Group to send the message to.
          +
          callback - The Callback with either the Success or Error message.
          +
          +
          • +
        + + + +
          +
        • +

          sendMessage

          +
          public void sendMessage(MASMessage message,
+                        MASGroup group,
+                        java.lang.String topic,
+                        MASCallback<java.lang.Void> callback)
          +
          Description copied from interface: MASMessenger
          +
          This method sends a message from the current user to an existing group on a specified topic.
          +
          +
          Specified by:
          +
          sendMessage in interface MASMessenger
          +
          Specified by:
          +
          sendMessage in class MASUser
          +
          Parameters:
          +
          message - The Message to be sent.
          +
          group - The Group to send the message to.
          +
          topic - The Topic on which the message to send.
          +
          callback - The Callback with either the Success or Error message.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          logout

          +
          public void logout(MASCallback<java.lang.Void> callback)
          +
          Description copied from class: MASUser
          +

          Logs off an already authenticated user via an asynchronous request.

          + This will invoke Callback.onSuccess(com.ca.mas.foundation.MASCallback<T>, T) upon a successful result.
          +
          +
          Specified by:
          +
          logout in class MASUser
          +
          Parameters:
          +
          callback - The Callback that receives the results. On a successful completion, the user + will be logout from the Application.
          +
          +
          • +
        + + + +
          +
        • +

          isAuthenticated

          +
          public boolean isAuthenticated()
          +
          Description copied from class: MASUser
          +
          Determines if the user is currently authenticated with the MAG server.
          +
          +
          Specified by:
          +
          isAuthenticated in class MASUser
          +
          +
          • +
        + + + +
          +
        • +

          isCurrentUser

          +
          public boolean isCurrentUser()
          +
          Description copied from class: MASUser
          +
          Determines if this user instance is the current authenticated user.
          +
          +
          Specified by:
          +
          isCurrentUser in class MASUser
          +
          +
          • +
        + + + +
          +
        • +

          requestUserInfo

          +
          public void requestUserInfo(MASCallback<java.lang.Void> callback)
          +
          Description copied from class: MASUser
          +
          Requesting userInfo for the MASUser object
          +
          +
          Specified by:
          +
          requestUserInfo in class MASUser
          +
          Parameters:
          +
          callback - The Callback that receives the results. On a successful completion, the user + available via MASUser.getCurrentUser() will be updated with the new information.
          +
          +
          • +
        + + + +
          +
        • +

          lockSession

          +
          public void lockSession(MASCallback<java.lang.Void> callback)
          +
          Description copied from class: MASUser
          +
          Locks the current device. + This will remove the access and refresh tokens, as well as the user profile. + The ID token will then be moved to the fingerprint protected shared KeyStore.
          +
          +
          Specified by:
          +
          lockSession in class MASUser
          +
          +
          • +
        + + + +
          +
        • +

          unlockSession

          +
          public void unlockSession(MASSessionUnlockCallback<java.lang.Void> callback)
          +
          Description copied from class: MASUser
          +
          Triggers the Android unlock and captures the unlock result. + Unlocks the ID_TOKEN from the KeyStore and places it back into the keychain, + removes the locked ID_TOKEN, and then indicates if the device is unlocked.
          +
          +
          Specified by:
          +
          unlockSession in class MASUser
          +
          +
          • +
        + + + +
          +
        • +

          isSessionLocked

          +
          public boolean isSessionLocked()
          +
          Description copied from class: MASUser
          +
          Checks to see if the device has a locked ID token.
          +
          +
          Specified by:
          +
          isSessionLocked in class MASUser
          +
          Returns:
          +
          true if there's a secured ID token
          +
          +
          • +
        + + + +
          +
        • +

          removeSessionLock

          +
          public void removeSessionLock(MASCallback<java.lang.Void> callback)
          +
          Description copied from class: MASUser
          +
          Removes the secured ID token.
          +
          +
          Specified by:
          +
          removeSessionLock in class MASUser
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public MASName getName()
          +
          Description copied from interface: ScimUser
          +
          Description: See MASName.
          +
          +
          Returns:
          +
          MASName the user's name object. Could be null.
          +
          +
          • +
        + + + +
          +
        • +

          getSource

          +
          public org.json.JSONObject getSource()
          +
          Description copied from interface: ScimUser
          +
          Retrieve the JSON source which use to populate this object.
          +
          +
          Returns:
          +
          The json source to populate the object.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/UserAttributes.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/UserAttributes.html new file mode 100644 index 00000000..f1ac9754 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/UserAttributes.html @@ -0,0 +1,362 @@ + + + + + +UserAttributes + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.identity.user
    +

    Class UserAttributes

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      MASTransformable
      +
      +
      +
      +
      public class UserAttributes
+extends Attributes
      +

      UserAttributes is the specialization of the Attributes class and deals specifically with SCIM users. UserAttributes is a + MASTransformable implementer that is able to populate itself.

      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        UserAttributes() +
        Description: No args constructor.
        +
        UserAttributes(java.util.List<java.lang.String> attributes) +
        Description: Convenience constructor.
        +
        +
        • +
      + + +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UserAttributes

          +
          public UserAttributes()
          +
          Description: No args constructor.
          +
          • +
        + + + +
          +
        • +

          UserAttributes

          +
          public UserAttributes(java.util.List<java.lang.String> attributes)
          +
          Description: Convenience constructor.
          +
          +
          Parameters:
          +
          attributes - the list of user attributes supported by this SCIM service.
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          populate

          +
          public void populate(@NonNull
+                     org.json.JSONObject jobj)
+              throws org.json.JSONException
          +
          Description copied from interface: MASTransformable
          +
          Description: +

          Populates the implementing class with the contents of the JSONObject. + A SCIM response contains a JSONObject with a defined structure, but much of the data could + be missing from the response, such as unpopulated fields, etc. Implementers need to determine + what is available.

          + Internal use only.
          +
          +
          Specified by:
          +
          populate in interface MASTransformable
          +
          Specified by:
          +
          populate in class Attributes
          +
          Parameters:
          +
          jobj - is the non-null JSON response from SCIM.
          +
          Throws:
          +
          org.json.JSONException - is thrown when the JSONObject is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getKey

          +
          protected java.lang.String getKey()
          +
          +
          Specified by:
          +
          getKey in class Attributes
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/UserNotAuthenticatedException.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/UserNotAuthenticatedException.html new file mode 100644 index 00000000..b72ff1ea --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/UserNotAuthenticatedException.html @@ -0,0 +1,303 @@ + + + + + +UserNotAuthenticatedException + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    com.ca.mas.identity.user
    +

    Class UserNotAuthenticatedException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • com.ca.mas.identity.user.UserNotAuthenticatedException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class UserNotAuthenticatedException
+extends java.lang.RuntimeException
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UserNotAuthenticatedException

          +
          public UserNotAuthenticatedException()
          +
          • +
        + + + +
          +
        • +

          UserNotAuthenticatedException

          +
          public UserNotAuthenticatedException(java.lang.String detailMessage)
          +
          • +
        + + + +
          +
        • +

          UserNotAuthenticatedException

          +
          public UserNotAuthenticatedException(java.lang.String detailMessage,
+                                     java.lang.Throwable throwable)
          +
          • +
        + + + +
          +
        • +

          UserNotAuthenticatedException

          +
          public UserNotAuthenticatedException(java.lang.Throwable throwable)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/package-frame.html index a5c8819b..30964e64 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/package-frame.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/package-frame.html @@ -2,9 +2,9 @@ - -com.ca.mas.identity.user (mas-foundation API) - + +com.ca.mas.identity.user + @@ -19,6 +19,7 @@

    Interfaces

    Classes

    +

    Exceptions

    + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/package-summary.html index e1fa57b0..f2623b92 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/package-summary.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/user/package-summary.html @@ -2,9 +2,9 @@ - -com.ca.mas.identity.user (mas-foundation API) - + +com.ca.mas.identity.user + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.identity.util
    +

    Class IdentityConsts

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/IdentityUtil.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/IdentityUtil.html new file mode 100644 index 00000000..82ff61ff --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/IdentityUtil.html @@ -0,0 +1,442 @@ + + + + + +IdentityUtil + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.identity.util
    +

    Class IdentityUtil

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.ca.mas.identity.util.IdentityUtil
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class IdentityUtil
+extends java.lang.Object
      +

      IdentityUtil implements helper methods used in creating SCIM URIs, + retreiving users and groups that have been retrieved via web service calls to SCIM, and for formatting date strings. Usages of + this class follow the static format of 'IdentityUtil.<method name>.

      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        static java.util.Map<java.lang.String,org.json.JSONObject>SCHEMA_MAP 
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        IdentityUtil() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static java.lang.StringgetGroupPath() 
        private static java.lang.StringgetPath(java.lang.String entity) +
        Returns the path component of the URL.
        +
        static android.graphics.BitmapgetPhoto(java.util.List<MASPhoto> photoList) +
        Pre-Conditions: The user must have been retrieved from SCIM.
        + Description: Format the byte stream in the Photo attribute so it can be displayed as a
        +
        static java.lang.StringgetSchemasPath() +
        Description: Create and return the path component of a URI of the form + /SCIM/MAS/v2/Schemas
        +
        static android.graphics.BitmapgetThumbnail(java.util.List<MASPhoto> photoList) 
        static java.lang.StringgetUserPath() +
        Pre-Conditions: The msso_config must be parsed.
        + Description: This helper method returns the User's URI as defined in the msso_config.json endpoint description.
        +
        static java.util.List<java.lang.String>normalizeAttributes(java.util.List<java.lang.String> providedAttributes, + java.util.List<java.lang.String> allowedAttributes) +
        Pre-Conditions: Must be called after the meta-information has been populated.
        + Description: Search for the attribute in the set of allowable attributes.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          SCHEMA_MAP

          +
          public static final java.util.Map<java.lang.String,org.json.JSONObject> SCHEMA_MAP
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IdentityUtil

          +
          public IdentityUtil()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getThumbnail

          +
          public static android.graphics.Bitmap getThumbnail(java.util.List<MASPhoto> photoList)
          +
          • +
        + + + +
          +
        • +

          normalizeAttributes

          +
          public static java.util.List<java.lang.String> normalizeAttributes(@NonNull
+                                                                   java.util.List<java.lang.String> providedAttributes,
+                                                                   @NonNull
+                                                                   java.util.List<java.lang.String> allowedAttributes)
          +
          Pre-Conditions: Must be called after the meta-information has been populated.
          + Description: Search for the attribute in the set of allowable attributes. The logic is as follows; + i. The exact match for the attribute must exist in the 'attributes' passed in, or + ii. The attribute must start with attrname. where the '.' precedes the fully qualified attribute name.
          +
          +
          Parameters:
          +
          providedAttributes -
          +
          allowedAttributes -
          +
          Returns:
          +
          List the list of attributes that exists in the attribute set.
          +
          +
          • +
        + + + +
          +
        • +

          getSchemasPath

          +
          public static java.lang.String getSchemasPath()
          +
          Description: Create and return the path component of a URI of the form + /SCIM/MAS/v2/Schemas
          +
          +
          Returns:
          +
          String the schemas path.
          +
          +
          • +
        + + + +
          +
        • +

          getUserPath

          +
          public static java.lang.String getUserPath()
          +
          Pre-Conditions: The msso_config must be parsed.
          + Description: This helper method returns the User's URI as defined in the msso_config.json endpoint description.
          +
          +
          Returns:
          +
          String the formatted URI for accessing Users, ex: SCIM/[provider]/v2/Users.
          +
          +
          • +
        + + + +
          +
        • +

          getGroupPath

          +
          public static java.lang.String getGroupPath()
          +
          • +
        + + + +
          +
        • +

          getPath

          +
          private static java.lang.String getPath(java.lang.String entity)
          +
          Returns the path component of the URL.
          +
          +
          Parameters:
          +
          entity - Entity to get path of.
          +
          Returns:
          +
          SCIM Path to entity as String.
          +
          +
          • +
        + + + +
          +
        • +

          getPhoto

          +
          public static android.graphics.Bitmap getPhoto(java.util.List<MASPhoto> photoList)
          +
          Pre-Conditions: The user must have been retrieved from SCIM.
          + Description: Format the byte stream in the Photo attribute so it can be displayed as a
          +
          +
          Parameters:
          +
          photoList - the list of photos from the MASUser.getUserById(String, MASCallback) call. See MASPhoto.
          +
          Returns:
          +
          Drawable the Android Drawable object for display. Could be null.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/package-frame.html new file mode 100644 index 00000000..c4ed21a6 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.ca.mas.identity.util + + + + + +

    com.ca.mas.identity.util

    +
    +

    Classes

    + +
    + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/package-summary.html new file mode 100644 index 00000000..0b35bd2d --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/package-summary.html @@ -0,0 +1,149 @@ + + + + + +com.ca.mas.identity.util + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package com.ca.mas.identity.util

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      IdentityConsts +
      IdentityConsts contains the set of constants used in this SCIM implementation.
      +
      IdentityUtil +
      IdentityUtil implements helper methods used in creating SCIM URIs, + retreiving users and groups that have been retrieved via web service calls to SCIM, and for formatting date strings.
      +
      +
      • +
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/package-tree.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/package-tree.html new file mode 100644 index 00000000..dba69398 --- /dev/null +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/identity/util/package-tree.html @@ -0,0 +1,140 @@ + + + + + +com.ca.mas.identity.util Class Hierarchy + + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package com.ca.mas.identity.util

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/MASMessage.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/MASMessage.html index 71c85449..400a3811 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/MASMessage.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/MASMessage.html @@ -2,9 +2,9 @@ - -MASMessage (mas-foundation API) - + +MASMessage + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.ca.mas.messaging
    +

    Class MessagingConsts

    +
    +
    + +
    +
      +
    • +
      +
      +
      public class MessagingConsts
+extends FoundationConsts
      +

      MessagingConsts contains the consts used by the messaging micro-service.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/package-frame.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/package-frame.html index 6b66bc84..e17f5a75 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/package-frame.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/package-frame.html @@ -2,9 +2,9 @@ - -com.ca.mas.messaging (mas-foundation API) - + +com.ca.mas.messaging + @@ -19,6 +19,7 @@

    Interfaces

    Classes

    Exceptions

      diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/package-summary.html index 5e504844..90f996b5 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/package-summary.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/package-summary.html @@ -2,9 +2,9 @@ - -com.ca.mas.messaging (mas-foundation API) - + +com.ca.mas.messaging + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ diff --git a/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/topic/package-summary.html b/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/topic/package-summary.html index 347f38b9..7a5f1c5c 100644 --- a/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/topic/package-summary.html +++ b/source/MASFoundation.Android/JavaDocs/com/ca/mas/messaging/topic/package-summary.html @@ -2,9 +2,9 @@ - -com.ca.mas.messaging.topic (mas-foundation API) - + +com.ca.mas.messaging.topic + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ - - - - - -
      - - -
      Skip navigation links
      - - - - -
      -
      -
        -
      • Prev
        • -
      • Next
        • -
      - - -
      - -
      - - -
      - -
      A B C D E F G H I J L M N O P R S T U V W  - - -

      A

      -
      -
      add(Certificate) - Method in class com.ca.mas.foundation.MASSecurityConfiguration.Builder
      -
      -
      Adds a certificate to the security configuration.
      -
      -
      add(String) - Method in class com.ca.mas.foundation.MASSecurityConfiguration.Builder
      -
      -
      Adds a public key hash to the security configuration.
      -
      -
      addAccount(AccountAuthenticatorResponse, String, String, String[], Bundle) - Method in class com.ca.mas.core.storage.sharedstorage.MASAuthenticator
      -
       
      -
      addMember(MASMember) - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Description: Add a new member to the group.
      -
      -
      addSecurityConfiguration(MASSecurityConfiguration) - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      Adds the security configuration to the list of configurations and notifies observers.
      -
      -
      API_TARGET_EXCEPTION - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      audience(String) - Method in class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Sets a singular audience for the MASClaims object.
      -
      -
      audience(List<String>) - Method in class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Sets an audience list for the MASClaims object.
      -
      -
      authorize(String, MASCallback<Void>) - Static method in class com.ca.mas.foundation.auth.MASProximityLoginNFC
      -
       
      -
      authorize(String, MASCallback<Void>) - Static method in class com.ca.mas.foundation.auth.MASProximityLoginQRCode
      -
       
      -
      authorize(MASAuthorizationRequest) - Method in interface com.ca.mas.foundation.MASAuthorizationRequestHandler
      -
      -
      Authorize the OAuth authorization code flow request.
      -
      -
      - - - -

      B

      -
      -
      BLE_ERROR_DISABLED - Static variable in class com.ca.mas.foundation.auth.MASProximityLoginBLE
      -
       
      -
      BLE_ERROR_INVALID_UUID - Static variable in class com.ca.mas.foundation.auth.MASProximityLoginBLE
      -
       
      -
      BLE_ERROR_NOT_SUPPORTED - Static variable in class com.ca.mas.foundation.auth.MASProximityLoginBLE
      -
       
      -
      BLE_ERROR_SESSION_SHARING_NOT_SUPPORTED - Static variable in class com.ca.mas.foundation.auth.MASProximityLoginBLE
      -
       
      -
      buffer - Variable in class com.ca.mas.foundation.MASResponseBody
      -
      -
      The response content
      -
      -
      build() - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      build() - Method in class com.ca.mas.foundation.MASClaimsBuilder
      -
       
      -
      build() - Method in class com.ca.mas.foundation.MASIdToken.Builder
      -
       
      -
      build() - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Builds the MASRequest object.
      -
      -
      build() - Method in class com.ca.mas.foundation.MASSecurityConfiguration.Builder
      -
      -
      Constructs a MASSecurityConfiguration object from the builder.
      -
      -
      buildDefault() - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      Builder() - Constructor for class com.ca.mas.foundation.MASIdToken.Builder
      -
       
      -
      Builder() - Constructor for class com.ca.mas.foundation.MASSecurityConfiguration.Builder
      -
       
      -
      byteArrayBody(byte[]) - Static method in class com.ca.mas.foundation.MASRequestBody
      -
       
      -
      byteArrayBody() - Static method in class com.ca.mas.foundation.MASResponseBody
      -
       
      -
      - - - -

      C

      -
      -
      cancel() - Method in class com.ca.mas.foundation.MASMultiFactorHandler
      -
      -
      Cancel the multi-factor authentication, the pending request from the queue will be removed.
      -
      -
      cancel(Bundle) - Method in class com.ca.mas.foundation.MASMultiFactorHandler
      -
      -
      Cancels the original request with additional information defined in multi factor authentication process - See MAS.cancelRequest(long, Bundle) for detail
      -
      -
      cancelAllRequest(Bundle) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Cancels all requests with additional information.
      -
      -
      cancelAllRequests() - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Cancels all requests.
      -
      -
      cancelRequest(long) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Cancels the specified request ID.
      -
      -
      cancelRequest(long, Bundle) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Cancels the specified request ID with additional information.
      -
      -
      canRegisterDevice() - Method in interface com.ca.mas.foundation.MASAuthCredentials
      -
       
      -
      canRegisterDevice() - Method in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      canRegisterDevice() - Method in class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      canRegisterDevice() - Method in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      canRegisterDevice() - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      claim(String, Object) - Method in class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Sets a claim key-value pair for the MASClaims object.
      -
      -
      clear() - Method in interface com.ca.mas.foundation.MASAuthCredentials
      -
      -
      Clear the credentials.
      -
      -
      clear() - Method in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      clear() - Method in class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      clear() - Method in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      clear() - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      clientCredential() - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Sets request grant type to MASGrantProvider.CLIENT_CREDENTIALS
      -
      -
      com.ca.mas.core.storage.implementation - package com.ca.mas.core.storage.implementation
      -
       
      -
      com.ca.mas.core.storage.sharedstorage - package com.ca.mas.core.storage.sharedstorage
      -
       
      -
      com.ca.mas.foundation - package com.ca.mas.foundation
      -
       
      -
      com.ca.mas.foundation.auth - package com.ca.mas.foundation.auth
      -
       
      -
      com.ca.mas.identity.common - package com.ca.mas.identity.common
      -
       
      -
      com.ca.mas.identity.group - package com.ca.mas.identity.group
      -
       
      -
      com.ca.mas.identity.user - package com.ca.mas.identity.user
      -
       
      -
      com.ca.mas.messaging - package com.ca.mas.messaging
      -
       
      -
      com.ca.mas.messaging.topic - package com.ca.mas.messaging.topic
      -
       
      -
      confirmCredentials(AccountAuthenticatorResponse, Account, Bundle) - Method in class com.ca.mas.core.storage.sharedstorage.MASAuthenticator
      -
       
      -
      connectionListener(MASConnectionListener) - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Register HttpURLConnection listener.
      -
      -
      contains(String, String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      contains(String, String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter attribute co filterValue.
      -
      -
      createCompoundExpression(MASFilteredRequestBuilder.Logical, MASRequest, MASRequest) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      createCompoundExpression(MASFilteredRequestBuilder.Logical, MASRequest, MASRequest) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter lhs [and|or|not] rhs.
      -
      -
      createJSONStringFromMASMessage(Context) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      createJSONStringFromMASMessage(Context) - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: This method takes the entire MASPayload attributes and create a Base64 encoded - version of the JSON document representing the payload.
      -
      -
      createMASMessageFromJSONString(String) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      createMASMessageFromJSONString(String) - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: This method takes a JSON object that has been turned into a String and attempts to turn it into a - MASPayload object.
      -
      -
      createUri(Context) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      createUri(Context) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: The Uri for the request is created based on the supplied filter(s).
      -
      -
      CREATOR - Static variable in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      CREATOR - Static variable in class com.ca.mas.foundation.auth.MASAuthenticationProviders
      -
       
      -
      CREATOR - Static variable in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      CREATOR - Static variable in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      CREATOR - Static variable in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
      -
      Factory for creating instances of the Parcelable class.
      -
      -
      CREATOR - Static variable in class com.ca.mas.foundation.MASMultiFactorHandler
      -
       
      -
      CREATOR - Static variable in class com.ca.mas.foundation.MASOtpAuthenticationHandler
      -
       
      -
      CREATOR - Static variable in class com.ca.mas.messaging.MASMessage
      -
       
      -
      - - - -

      D

      -
      -
      DEBUG - Static variable in class com.ca.mas.foundation.MAS
      -
       
      -
      debug() - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Turn on debug mode
      -
      -
      delete(String) - Method in class com.ca.mas.core.storage.sharedstorage.MASSharedStorage
      -
      -
      Deletes any data with the given key in the shared storage.
      -
      -
      delete(MASCallback<Void>) - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Deletes the group object in the cloud.
      -
      -
      delete(MASRequestBody) - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Sets the request method to DELETE with MASRequestBody, - set MASRequestBody to null if not request body to send.
      -
      -
      delete(MASGroup, MASCallback<Void>) - Method in interface com.ca.mas.identity.group.MASGroupRepository
      -
       
      -
      deliver(String, MASCallback<Void>) - Method in class com.ca.mas.foundation.MASOtpAuthenticationHandler
      -
      -
      Proceed to invoke server to deliver the OTP to the given delivery channel.
      -
      -
      deregister(MASCallback<Void>) - Method in class com.ca.mas.foundation.MASDevice
      -
      -
      Deregisters the application resources on this device.
      -
      -
      describeContents() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      describeContents() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProviders
      -
       
      -
      describeContents() - Method in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      describeContents() - Method in class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      describeContents() - Method in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      describeContents() - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      describeContents() - Method in class com.ca.mas.foundation.MASMultiFactorHandler
      -
       
      -
      describeContents() - Method in class com.ca.mas.foundation.MASOtpAuthenticationHandler
      -
       
      -
      describeContents() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      Device - Interface in com.ca.mas.foundation
      -
      -
      The Device interface is a local representation of device data.
      -
      -
      - - - -

      E

      -
      -
      editProperties(AccountAuthenticatorResponse, String) - Method in class com.ca.mas.core.storage.sharedstorage.MASAuthenticator
      -
       
      -
      enableBrowserBasedAuthentication() - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Enables Browser Based Authentication for authorization (set to false by default).
      -
      -
      enablePKCE(boolean) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Enable PKCE extension to OAuth.
      -
      -
      endsWith(String, String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      endsWith(String, String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter attribute ew filterValue.
      -
      -
      expirationTime(Date) - Method in class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Sets the expiration time for the MASClaims object.
      -
      -
      - - - -

      F

      -
      -
      fromUri(Uri) - Static method in class com.ca.mas.foundation.MASAuthorizationResponse
      -
      -
      Extracts an authorization response from redirect uri.
      -
      -
      - - - -

      G

      -
      -
      gatewayIsReachable(MASCallback<Boolean>) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Retrieves a boolean indicating if the gateway is currently reachable or not.
      -
      -
      get() - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Sets the request method to GET.
      -
      -
      getAccessToken() - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      getAccountRemovalAllowed(AccountAuthenticatorResponse, Account) - Method in class com.ca.mas.core.storage.sharedstorage.MASAuthenticator
      -
       
      -
      getAddressList() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of addresses
      -
      -
      getApplicationDescription() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      The description of the application.
      -
      -
      getApplicationName() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      The name of the applications.
      -
      -
      getApplicationOrganization() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      The organization name of the application.
      -
      -
      getApplicationRegisteredBy() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      The name of the entity that registered the application.
      -
      -
      getApplicationType() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      The type of the application.
      -
      -
      getAsJSONObject() - Method in class com.ca.mas.identity.user.MASAddress
      -
       
      -
      getAsJSONObject() - Method in class com.ca.mas.identity.user.MASEmail
      -
       
      -
      getAsJSONObject() - Method in class com.ca.mas.identity.user.MASMeta
      -
       
      -
      getAsJSONObject() - Method in class com.ca.mas.identity.user.MASName
      -
       
      -
      getAudience() - Method in interface com.ca.mas.foundation.MASClaims
      -
      -
      Get the audience for the claims object.
      -
      -
      getAuthConfiguration(Context, MASAuthenticationProvider, MASCallback<Uri>) - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      getAuthenticationProviders(MASCallback<MASAuthenticationProviders>) - Static method in class com.ca.mas.foundation.auth.MASAuthenticationProviders
      -
      -
      Send an authorization request to MAG and retrieves the MASAuthenticationProviders from the server.
      -
      -
      getAuthenticationUrl() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      getAuthorizationCode() - Method in class com.ca.mas.foundation.MASAuthorizationResponse
      -
       
      -
      getAuthToken(AccountAuthenticatorResponse, Account, String, Bundle) - Method in class com.ca.mas.core.storage.sharedstorage.MASAuthenticator
      -
       
      -
      getAuthTokenLabel(String) - Method in class com.ca.mas.core.storage.sharedstorage.MASAuthenticator
      -
       
      -
      getAuthUrl() - Method in class com.ca.mas.foundation.auth.MASApplication
      -
       
      -
      getBody() - Method in interface com.ca.mas.foundation.MASRequest
      -
       
      -
      getBody() - Method in interface com.ca.mas.foundation.MASResponse
      -
      -
      Returns the response body returned by the remote MAG Server
      -
      -
      getBytes(String) - Method in class com.ca.mas.core.storage.sharedstorage.MASSharedStorage
      -
      -
      Retrieves a byte array in the shared storage given by the key.
      -
      -
      getCertificateAdvancedRenewTimeframe() - Method in class com.ca.mas.foundation.MASConfiguration
      -
       
      -
      getCertificates() - Method in interface com.ca.mas.foundation.MASSecurityConfiguration
      -
       
      -
      getChannels() - Method in class com.ca.mas.foundation.MASOtpAuthenticationHandler
      -
       
      -
      getClaims() - Method in interface com.ca.mas.foundation.MASClaims
      -
      -
      Get all the claim key-value pairs for the claims object.
      -
      -
      getClientId() - Method in class com.ca.mas.foundation.MASAuthorizationRequest
      -
       
      -
      getClientId() - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      getConnectionListener() - Method in interface com.ca.mas.foundation.MASRequest
      -
       
      -
      getContent() - Method in class com.ca.mas.foundation.MASResponseBody
      -
      -
      Return the parsed response content.
      -
      -
      getContentAsJsonValue() - Method in class com.ca.mas.foundation.MASRequestBody
      -
       
      -
      getContentEncoding() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      getContentEncoding() - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: The payload's content encoding.
      -
      -
      getContentLength() - Method in class com.ca.mas.foundation.MASRequestBody
      -
       
      -
      getContentLength() - Method in class com.ca.mas.foundation.MASResponseBody
      -
      -
      Returns the content length in bytes specified by the response header field.
      -
      -
      getContentType() - Method in class com.ca.mas.foundation.MASRequestBody
      -
       
      -
      getContentType() - Method in class com.ca.mas.foundation.MASResponseBody
      -
      -
      Returns the MIME-type of the content specified by the response header field - Please refer to URLConnection.getContentType() for detail.
      -
      -
      getContentType() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      getContentType() - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: Get the {IANA MIME} media type.
      -
      -
      getContext() - Static method in class com.ca.mas.foundation.MAS
      -
       
      -
      getCountry() - Method in class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: Getter for the country name component.
      -
      -
      getCreated() - Method in class com.ca.mas.identity.user.MASMeta
      -
      -
      Description: The "DateTime" that the resource was added to the service - provider.
      -
      -
      getCredentials(MssoContext) - Method in enum com.ca.mas.foundation.MASGrantProvider
      -
       
      -
      getCurrentActivity() - Static method in class com.ca.mas.foundation.MAS
      -
       
      -
      getCurrentConfiguration() - Static method in class com.ca.mas.foundation.MASConfiguration
      -
       
      -
      getCurrentDevice() - Static method in class com.ca.mas.foundation.MASDevice
      -
       
      -
      getCurrentUser() - Static method in class com.ca.mas.foundation.MASUser
      -
      -
      Retrieves the currently authenticated user.
      -
      -
      getCustom() - Method in class com.ca.mas.foundation.auth.MASApplication
      -
       
      -
      getData() - Method in exception com.ca.mas.foundation.MAS.RequestCancelledException
      -
       
      -
      getDisplay() - Method in class com.ca.mas.foundation.MASAuthorizationRequest
      -
       
      -
      getDisplay() - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      getDisplay() - Method in class com.ca.mas.identity.group.MASMember
      -
      -
      Description: Getter.
      -
      -
      getDisplay() - Method in class com.ca.mas.identity.group.MASOwner
      -
      -
      Description: Getter.
      -
      -
      getDisplayName() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      getDisplayName() - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: The string value set by the application developer.
      -
      -
      getEmailList() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of emails
      -
      -
      getEndpointPath(String) - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      Retrieves an endpoint path fragment for a given endpoint key, the keys can be one of the following - - msso.url.request_token - msso.url.request_token_sso - msso.url.register_device - msso.url.register_device_client - msso.url.resource_owner_logout - msso.url.remove_device_x509 - msso.url.authorize - msso.url.enterprise_apps - msso.url.client_credentials - msso.url.authorize - mas.url.scim_path - mas.url.mas_storage_path - mas.url.user_info -
      -
      -
      getExpirationTime() - Method in interface com.ca.mas.foundation.MASClaims
      -
      -
      Get the expiration time for the claims object.
      -
      -
      getFamilyName() - Method in class com.ca.mas.identity.user.MASName
      -
      -
      Description: See the SCIM definition of familyName
      -
      -
      getFormatted() - Method in class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: Getter that returns the full mailing address, formatted for display or use with a mailing label.
      -
      -
      getFormatted() - Method in class com.ca.mas.identity.user.MASName
      -
      -
      Description: See the SCIM definition of formatted
      -
      -
      getGatewayCertificates() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      The public server certificate of the Gateway as obtained from the configuration.
      -
      -
      getGatewayHostName() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      The host name of the Gateway.
      -
      -
      getGatewayPort() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      The port assigned on the Gateway.
      -
      -
      getGatewayPrefix() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      The prefix assigned on the Gateway.
      -
      -
      getGatewayUrl() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      The full URL of the Gateway including the prefix, hostname and port in a ://: format.
      -
      -
      getGivenName() - Method in class com.ca.mas.identity.user.MASName
      -
      -
      Description: See the SCIM definition of givenName
      -
      -
      getGrantProvider() - Method in interface com.ca.mas.foundation.MASRequest
      -
       
      -
      getGrantType() - Method in interface com.ca.mas.foundation.MASAuthCredentials
      -
       
      -
      getGrantType() - Method in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      getGrantType() - Method in class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      getGrantType() - Method in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      getGrantType() - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      getGroupById(String, MASCallback<MASGroup>) - Method in class com.ca.mas.foundation.MASGroup
      -
       
      -
      getGroupById(String, MASCallback<MASGroup>) - Method in interface com.ca.mas.identity.group.MASGroupIdentity
      -
      -
      Retrieves a MASGroup object matching the objectId with specific attributes.
      -
      -
      getGroupById(String, MASCallback<MASGroup>) - Method in interface com.ca.mas.identity.group.MASGroupRepository
      -
      -
      Retrieves a MASGroup object matching the objectId with specific attributes.
      -
      -
      getGroupList() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of groups
      -
      -
      getGroupMetaData(MASCallback<GroupAttributes>) - Method in class com.ca.mas.foundation.MASGroup
      -
       
      -
      getGroupMetaData(MASCallback<GroupAttributes>) - Method in interface com.ca.mas.identity.group.MASGroupIdentity
      -
      -
      Retrieves the supported SCIM attribute options.
      -
      -
      getGroupMetaData(MASCallback<GroupAttributes>) - Method in interface com.ca.mas.identity.group.MASGroupRepository
      -
      -
      Retrieves the supported SCIM attribute options.
      -
      -
      getGroupName() - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Description: This method returns the group name used to display.
      -
      -
      getGroupsByFilter(MASFilteredRequest, MASCallback<List<MASGroup>>) - Method in class com.ca.mas.foundation.MASGroup
      -
       
      -
      getGroupsByFilter(MASFilteredRequest, MASCallback<List<MASGroup>>) - Method in interface com.ca.mas.identity.group.MASGroupIdentity
      -
      -
      Retrieves MASGroup objects that match the MASFilteredRequest.
      -
      -
      getGroupsByFilter(MASFilteredRequest, MASCallback<List<MASGroup>>) - Method in interface com.ca.mas.identity.group.MASGroupRepository
      -
      -
      Retrieves MASGroup objects that match the MASFilteredRequest.
      -
      -
      getHandler() - Method in class com.ca.mas.foundation.MASCallback
      -
      -
      The Handler to handle the callback, refer to Handler for details
      -
      -
      getHeaders() - Method in interface com.ca.mas.foundation.MASAuthCredentials
      -
      -
      Return the authorization headers that are sent to the gateway.
      -
      -
      getHeaders() - Method in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      getHeaders() - Method in class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      getHeaders() - Method in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      getHeaders() - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      getHeaders() - Method in interface com.ca.mas.foundation.MASRequest
      -
       
      -
      getHeaders() - Method in interface com.ca.mas.foundation.MASResponse
      -
      -
      Returns an unmodifiable map of the response-header fields and values.
      -
      -
      getHonorificPrefix() - Method in class com.ca.mas.identity.user.MASName
      -
      -
      Description: See the SCIM definition of honorificPrefix
      -
      -
      getHonorificSuffix() - Method in class com.ca.mas.identity.user.MASName
      -
      -
      Description: See the SCIM definition of honorificSuffix
      -
      -
      getHost() - Method in interface com.ca.mas.foundation.MASSecurityConfiguration
      -
       
      -
      getIconUrl() - Method in class com.ca.mas.foundation.auth.MASApplication
      -
       
      -
      getId() - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Description: Getter for the group ID.
      -
      -
      getIdentifier() - Method in class com.ca.mas.foundation.auth.MASApplication
      -
       
      -
      getIdentifier() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      getIdentifier() - Method in class com.ca.mas.foundation.MASDevice
      -
      -
      The MASDevice identifier.
      -
      -
      getIdp() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProviders
      -
       
      -
      getImsList() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of addresses
      -
      -
      getIssuedAt() - Method in interface com.ca.mas.foundation.MASClaims
      -
      -
      Get the issue time for the claims object.
      -
      -
      getIssuer() - Method in interface com.ca.mas.foundation.MASClaims
      -
      -
      Get the issuer for the claims object.
      -
      -
      getJwtId() - Method in interface com.ca.mas.foundation.MASClaims
      -
      -
      Get the JWT ID for the claims object.
      -
      -
      getLastModified() - Method in class com.ca.mas.identity.user.MASMeta
      -
      -
      Description: The most recent DateTime that the details of this resource were updated at the service provider.
      -
      -
      getLocale() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of locale
      -
      -
      getLocality() - Method in class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: Getter representing the city or locality component.
      -
      -
      getLocation() - Method in class com.ca.mas.identity.user.MASMeta
      -
      -
      Description: The URI of the resource being returned.
      -
      -
      getLocationIsRequired() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      Determines if a user’s location coordinates are required.
      -
      -
      getMembers() - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Description: Getter.
      -
      -
      getMeta() - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Description: Get the metadata for the group, if it exists.
      -
      -
      getMeta() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See MASMeta.
      -
      -
      getMethod() - Method in interface com.ca.mas.foundation.MASRequest
      -
       
      -
      getMiddleName() - Method in class com.ca.mas.identity.user.MASName
      -
      -
      Description: See the SCIM definition of middleName
      -
      -
      getMultiFactorHandler(long, MASRequest, MASResponse<?>) - Method in class com.ca.mas.foundation.MASMultiFactorAuthenticator
      -
      -
      Determines whether the custom MFA object can or will handle flow based on the response of the original request.
      -
      -
      getMultiFactorHandler(long, MASRequest, MASResponse<?>) - Method in class com.ca.mas.foundation.MASOtpMultiFactorAuthenticator
      -
       
      -
      getName() - Method in class com.ca.mas.foundation.auth.MASApplication
      -
       
      -
      getName() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See MASName.
      -
      -
      getNativeUri() - Method in class com.ca.mas.foundation.auth.MASApplication
      -
       
      -
      getNickName() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of nickName
      -
      -
      getNotBefore() - Method in interface com.ca.mas.foundation.MASClaims
      -
      -
      Get the earliest processing time for the claims object.
      -
      -
      getOwner() - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Description: Getter.
      -
      -
      getParams() - Method in interface com.ca.mas.foundation.MASAuthCredentials
      -
       
      -
      getParams() - Method in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      getParams() - Method in class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      getParams() - Method in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      getParams() - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      getPassword() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of password
      -
      -
      getPayload() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      getPayload() - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: This payload is a byte stream that is meaningful to the receiving client.
      -
      -
      getPhoneList() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of phoneNumbers
      -
      -
      getPhotoList() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of photos
      -
      -
      getPollUrl() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      getPostalCode() - Method in class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: Getter for the user's postal code associated with this address.
      -
      -
      getPreferredLanguage() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of preferredLanguage
      -
      -
      getProfileUrl() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of profileUrl
      -
      -
      getProviders() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProviders
      -
       
      -
      getPublicKeyHashes() - Method in interface com.ca.mas.foundation.MASSecurityConfiguration
      -
       
      -
      getQos() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      getQos() - Method in interface com.ca.mas.messaging.topic.MASTopic
      -
      -
      Description: - - 0 - at most once - 1 - at least once - 2 - exactly once -
      -
      -
      getRawContent() - Method in class com.ca.mas.foundation.MASResponseBody
      -
      -
      Return the un-parsed response.
      -
      -
      getRedirectUri() - Method in class com.ca.mas.foundation.MASAuthorizationRequest
      -
       
      -
      getRedirectUri() - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      getRef() - Method in class com.ca.mas.identity.group.MASMember
      -
      -
      Description: Getter.
      -
      -
      getRef() - Method in class com.ca.mas.identity.group.MASOwner
      -
      -
      Description: Getter.
      -
      -
      getReference() - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Description: - The reference is a URI that can be used to make a web service call to get the details of this group, - e.g.
      -
      -
      getRegion() - Method in class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: The state or region component.
      -
      -
      getRegistrationPath(MssoContext) - Method in enum com.ca.mas.foundation.MASGrantProvider
      -
       
      -
      getRequestTimeout() - Method in class com.ca.mas.foundation.auth.MASWebApplication
      -
       
      -
      getResourceType() - Method in class com.ca.mas.identity.user.MASMeta
      -
      -
      Description: The name of the resource type of the resource.
      -
      -
      getResponseBody() - Method in interface com.ca.mas.foundation.MASRequest
      -
       
      -
      getResponseCode() - Method in interface com.ca.mas.foundation.MASResponse
      -
      -
      Returns the response code returned by the remote MAG server.
      -
      -
      getResponseMessage() - Method in interface com.ca.mas.foundation.MASResponse
      -
      -
      Returns the response message returned by the remote MAG server.
      -
      -
      getResponseType() - Method in class com.ca.mas.foundation.MASAuthorizationRequest
      -
       
      -
      getResponseType() - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      getRootCause() - Method in class com.ca.mas.foundation.MASException
      -
       
      -
      getRootCause(Throwable) - Method in class com.ca.mas.foundation.MASException
      -
       
      -
      getScope() - Method in class com.ca.mas.foundation.MASAuthorizationRequest
      -
       
      -
      getScope() - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      getScope() - Method in interface com.ca.mas.foundation.MASRequest
      -
       
      -
      getSecurityConfiguration(Uri) - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      Returns a MASSecurityConfiguration object for the specified domain.
      -
      -
      getSenderId() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      getSenderId() - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: The Id of the sender from the MASUser instance.
      -
      -
      getSenderType() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      getSenderType() - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: Get the sender type that has context within the implementing application.
      -
      -
      getSentTime() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      getSentTime() - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: The number of milliseconds since the Epoch returned by an OS call to getTime, for example.
      -
      -
      getSource() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Retrieve the JSON source which use to populate this object.
      -
      -
      getState(Context) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Returns current MASState value.
      -
      -
      getState() - Method in class com.ca.mas.foundation.MASAuthorizationRequest
      -
       
      -
      getState() - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      getState() - Method in class com.ca.mas.foundation.MASAuthorizationResponse
      -
       
      -
      getStorage(String, Object) - Method in class com.ca.mas.core.storage.implementation.MASStorageManager
      -
      -
      Gets the named storage using reflection.
      -
      -
      getStorage(Class<? extends Storage>, Object) - Method in class com.ca.mas.core.storage.implementation.MASStorageManager
      -
      -
      Gets the named storage using reflection.
      -
      -
      getStorage(MASStorageManager.MASStorageType, Object) - Method in class com.ca.mas.core.storage.implementation.MASStorageManager
      -
      -
      Gets the Storage of the specified type.
      -
      -
      getStreetAddress() - Method in class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: Getter representing the full street address component, which may include house number, street name, P.O.
      -
      -
      getString(String) - Method in class com.ca.mas.core.storage.sharedstorage.MASSharedStorage
      -
      -
      Retrieves a string value in the shared storage given by the key.
      -
      -
      getSubject() - Method in interface com.ca.mas.foundation.MASClaims
      -
      -
      Get the subject for the claims object.
      -
      -
      getThumbnailImage() - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      getTimeZone() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of timezone
      -
      -
      getTitle() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of title
      -
      -
      getTopic() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      getType() - Method in class com.ca.mas.identity.group.MASMember
      -
      -
      Description: Getter.
      -
      -
      getType() - Method in class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: Getter that returns the type of address this information represents such as 'work', 'home', etc.
      -
      -
      getURL() - Method in interface com.ca.mas.foundation.MASRequest
      -
       
      -
      getUserById(String, MASCallback<MASUser>) - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      getUserById(String, MASCallback<MASUser>) - Method in interface com.ca.mas.identity.user.MASUserIdentity
      -
      -
      Retrieves a MASUser' matching the id.
      -
      -
      getUserMetaData(MASCallback<UserAttributes>) - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      getUserMetaData(MASCallback<UserAttributes>) - Method in interface com.ca.mas.identity.user.MASUserIdentity
      -
      -
      Retrieves the supported SCIM attribute options.
      -
      -
      getUsername() - Method in interface com.ca.mas.foundation.MASAuthCredentials
      -
       
      -
      getUsername() - Method in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      getUsername() - Method in class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      getUsername() - Method in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      getUsername() - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      getUserName() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of userName
      -
      -
      getUsersByFilter(MASFilteredRequest, MASCallback<List<MASUser>>) - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      getUsersByFilter(MASFilteredRequest, MASCallback<List<MASUser>>) - Method in interface com.ca.mas.identity.user.MASUserIdentity
      -
      -
      Retrieves MASUser objects that matches the MASFilteredRequest.
      -
      -
      getUserType() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description: See the SCIM definition of userType
      -
      -
      getValue() - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Description: Value accessor which could be a GUID, - e.g.
      -
      -
      getValue() - Method in class com.ca.mas.identity.group.MASMember
      -
      -
      Description: Getter.
      -
      -
      getValue() - Method in class com.ca.mas.identity.group.MASOwner
      -
      -
      Description: Getter.
      -
      -
      getVersion() - Method in class com.ca.mas.identity.user.MASMeta
      -
      -
      Description: The version of the resource being returned.
      -
      -
      getVersion() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      getVersion() - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: The version will always be 1.0.
      -
      -
      getWebViewClient() - Method in class com.ca.mas.foundation.auth.MASWebApplication
      -
      -
      The SDK uses WebView to display a Web browser application, it registers a WebViewClient.shouldInterceptRequest(WebView, WebResourceRequest) - to the WebView to intercept request.
      -
      -
      - - - -

      H

      -
      -
      hasFeatures(AccountAuthenticatorResponse, Account, String[]) - Method in class com.ca.mas.core.storage.sharedstorage.MASAuthenticator
      -
       
      -
      header(String, String) - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Adds the specified header to the request.
      -
      -
      host(Uri) - Method in class com.ca.mas.foundation.MASSecurityConfiguration.Builder
      -
      -
      The URI of the designated host.
      -
      -
      - - - -

      I

      -
      -
      init(Activity, long, MASAuthenticationProviders) - Method in interface com.ca.mas.foundation.auth.MASProximityLogin
      -
      -
      Initialize the Renderer,
      -
      -
      init(Activity, long, MASAuthenticationProviders) - Method in class com.ca.mas.foundation.auth.MASProximityLoginBLE
      -
       
      -
      init(Activity, long, MASAuthenticationProviders) - Method in class com.ca.mas.foundation.auth.MASProximityLoginNFC
      -
       
      -
      init(Activity, long, MASAuthenticationProviders) - Method in class com.ca.mas.foundation.auth.MASProximityLoginQRCode
      -
       
      -
      intercept(long, MASRequest, Bundle, MASResponse<?>) - Method in class com.ca.mas.foundation.MASMultiFactorAuthenticator
      -
       
      -
      invoke(MASRequest, MASCallback<MASResponse<T>>) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Request method for an HTTP POST, PUT, DELETE, GET call to the Gateway.
      -
      -
      isActive() - Method in interface com.ca.mas.identity.user.ScimUser
      -
      -
      Description:See the SCIM definition of active
      -
      -
      isAuthenticated() - Method in class com.ca.mas.foundation.MASUser
      -
      -
      Determines if the user is currently authenticated with the MAG server.
      -
      -
      isAuthenticationListenerRegistered() - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Checks whether the consumer of MAS has set any authentication listener or not.
      -
      -
      isBrowserBasedAuthenticationEnabled() - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Checks if is enabled or not for authorization (returns false by default).
      -
      -
      isCurrentUser() - Method in class com.ca.mas.foundation.MASUser
      -
      -
      Determines if this user instance is the current authenticated user.
      -
      -
      isDuplicate() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      isEnabledPublicKeyPinning() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      Determines if the SDK is enabled for public key pinning for an authentication challenge.
      -
      -
      isEnabledTrustedPublicPKI() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      Determines if the SDK will trust the public PKI for an authentication challenge.
      -
      -
      isEnterprise() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      isEqualTo(String, String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      isEqualTo(String, String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter attribute eq filterValue.
      -
      -
      isFacebook() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      isGoogle() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      isGreaterThan(String, String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      isGreaterThan(String, String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter attribute gt filterValue.
      -
      -
      isGreaterThanOrEqual(String, String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      isGreaterThanOrEqual(String, String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter attribute ge filterValue.
      -
      -
      isInvalidOtp() - Method in class com.ca.mas.foundation.MASOtpAuthenticationHandler
      -
       
      -
      isLessThan(String, String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      isLessThan(String, String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter attribute lt filterValue.
      -
      -
      isLessThanOrEqual(String, String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      isLessThanOrEqual(String, String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter attribute le filterValue.
      -
      -
      isLinkedIn() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      isLoaded() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      This indicates the status of the configuration loading.
      -
      -
      isNotEqualTo(String, String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      isNotEqualTo(String, String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter attribute ne filterValue.
      -
      -
      isPKCEEnabled() - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Determines whether PKCE extension is enabled.
      -
      -
      isPresent(String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      isPresent(String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the unary filter attribute pr.
      -
      -
      isPrimary() - Method in class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: The predicate that signifies whether the address is the primary address.
      -
      -
      isPrimary() - Method in class com.ca.mas.identity.user.MASEmail
      -
       
      -
      isProximityLogin() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      isPublic() - Method in interface com.ca.mas.foundation.MASRequest
      -
       
      -
      isPublic(boolean) - Method in class com.ca.mas.foundation.MASSecurityConfiguration.Builder
      -
      -
      Determines whether or not to include sensitive credentials from primary gateway in the network communication with the target host.
      -
      -
      isPublic() - Method in interface com.ca.mas.foundation.MASSecurityConfiguration
      -
       
      -
      isRegistered() - Method in class com.ca.mas.foundation.MASDevice
      -
      -
      Is the MASDevice registered?
      -
      -
      isRetained() - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      isReusable() - Method in interface com.ca.mas.foundation.MASAuthCredentials
      -
       
      -
      isReusable() - Method in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
      -
      The authorization code can only be use for one time only, it considers invalid after.
      -
      -
      isReusable() - Method in class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      isReusable() - Method in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      isReusable() - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      isSalesForce() - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      isSessionLocked() - Method in class com.ca.mas.foundation.MASUser
      -
      -
      Checks to see if the device has a locked ID token.
      -
      -
      isSessionSupported() - Method in enum com.ca.mas.foundation.MASGrantProvider
      -
       
      -
      isSsoEnabled() - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      Determines if the client’s SSO is enabled or not.
      -
      -
      issuer(String) - Method in class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Sets the issuer for the MASClaims object.
      -
      -
      issueTime(Date) - Method in class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Sets the issue time for the MASClaims object.
      -
      -
      isValid() - Method in interface com.ca.mas.foundation.MASAuthCredentials
      -
       
      -
      isValid() - Method in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      isValid() - Method in class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      isValid() - Method in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      isValid() - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      - - - -

      J

      -
      -
      jsonArrayBody(JSONArray) - Static method in class com.ca.mas.foundation.MASRequestBody
      -
       
      -
      jsonBody(JSONObject) - Static method in class com.ca.mas.foundation.MASRequestBody
      -
       
      -
      jsonBody() - Static method in class com.ca.mas.foundation.MASResponseBody
      -
       
      -
      jwtId(String) - Method in class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Sets the JWT ID for the MASClaims object.
      -
      -
      - - - -

      L

      -
      -
      lockSession(MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
      -
      Locks the current device.
      -
      -
      login(MASAuthorizationRequest, MASAuthorizationRequestHandler) - Static method in class com.ca.mas.foundation.MASUser
      -
      -
      Login with OAuth2 Authorization request
      -
      -
      login(String, char[], MASCallback<MASUser>) - Static method in class com.ca.mas.foundation.MASUser
      -
      -
      Authenticates a user with a username and password.
      -
      -
      login(MASIdToken, MASCallback<MASUser>) - Static method in class com.ca.mas.foundation.MASUser
      -
      -
      Authenticates a user with an ID token.
      -
      -
      login(MASAuthCredentials, MASCallback<MASUser>) - Static method in class com.ca.mas.foundation.MASUser
      -
      -
      Authenticates a user with a MASAuthCredentials object.
      -
      -
      login(MASCallback<MASUser>) - Static method in class com.ca.mas.foundation.MASUser
      -
      -
      Performs an implicit login by calling an endpoint that requires authentication.
      -
      -
      login(MASAuthorizationResponse, MASCallback<MASUser>) - Static method in class com.ca.mas.foundation.MASUser
      -
      -
      Authenticates a user with an authorization code.
      -
      -
      logout(MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
      -
      Logs off an already authenticated user via an asynchronous request.
      -
      -
      - - - -

      M

      -
      -
      MAS - Class in com.ca.mas.foundation
      -
      -
      The top level MAS object represents the Mobile App Services SDK in its entirety.
      -
      -
      MAS.RequestCancelledException - Exception in com.ca.mas.foundation
      -
       
      -
      MAS_APPLICATION - Static variable in class com.ca.mas.foundation.MASConstants
      -
       
      -
      MAS_GRANT_FLOW_CLIENT_CREDENTIALS - Static variable in class com.ca.mas.foundation.MASConstants
      -
      -
      The client credentials grant flow.
      -
      -
      MAS_GRANT_FLOW_PASSWORD - Static variable in class com.ca.mas.foundation.MASConstants
      -
      -
      The user credentials grant flow.
      -
      -
      MAS_STATE_NOT_CONFIGURED - Static variable in class com.ca.mas.foundation.MASConstants
      -
      -
      State that SDK has not been initialized and does not have configuration file - either in local file system based on the default configuration file name, nor in the keychain storage.
      -
      -
      MAS_STATE_NOT_INITIALIZED - Static variable in class com.ca.mas.foundation.MASConstants
      -
      -
      State that SDK has the active configuration either in the local file system, but has not been initialized yet.
      -
      -
      MAS_STATE_STARTED - Static variable in class com.ca.mas.foundation.MASConstants
      -
      -
      State that SDK did start; at this state, SDK should be fully functional.
      -
      -
      MAS_STATE_STOPPED - Static variable in class com.ca.mas.foundation.MASConstants
      -
      -
      State that SDK did stop; at this state, SDK is properly stopped and should be able to re-start.
      -
      -
      MAS_USER - Static variable in class com.ca.mas.foundation.MASConstants
      -
       
      -
      MASAddress - Class in com.ca.mas.identity.user
      -
      -
      The MASAddress interface contains the common attribute address - components of a single user's address.
      -
      -
      MASAddress() - Constructor for class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: Default no-args constructor.
      -
      -
      MASAddress(String, String, String, String, String) - Constructor for class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: Convenience constructor for creating an Address object.
      -
      -
      MASApplication - Class in com.ca.mas.foundation.auth
      -
      -
      The Enterprise browser manages a trusted group of enterprise approved applications on a device.
      -
      -
      MASApplication.MASApplicationLauncher - Class in com.ca.mas.foundation.auth
      -
       
      -
      MASApplicationLauncher() - Constructor for class com.ca.mas.foundation.auth.MASApplication.MASApplicationLauncher
      -
       
      -
      MASAuthCredentials - Interface in com.ca.mas.foundation
      -
      -
      An interface for including the headers and parameters for a set of authorization credentials.
      -
      -
      MASAuthCredentialsAuthorizationCode - Class in com.ca.mas.foundation
      -
      -
      MASAuthCredentials for Authorization Code Grant Type
      -
      -
      MASAuthCredentialsAuthorizationCode(String, String) - Constructor for class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      MASAuthCredentialsAuthorizationCode(Parcel) - Constructor for class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      MASAuthCredentialsClientCredentials - Class in com.ca.mas.foundation
      -
      -
      MASAuthCredentials for Client Credentials Grant Type
      -
      -
      MASAuthCredentialsClientCredentials() - Constructor for class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      MASAuthCredentialsJWT - Class in com.ca.mas.foundation
      -
      -
      MASAuthCredentials for JWT Grant Type
      -
      -
      MASAuthCredentialsJWT(IdToken) - Constructor for class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      MASAuthCredentialsPassword - Class in com.ca.mas.foundation
      -
      -
      MASAuthCredentials for Username & Password Grant Type
      -
      -
      MASAuthCredentialsPassword(String, char[]) - Constructor for class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
      -
      Create a UsernamePassword holding the specified username and password.
      -
      -
      MASAuthenticationListener - Interface in com.ca.mas.foundation
      -
      -
      Interface that will receive various notifications and requests for MAG Client.
      -
      -
      MASAuthenticationProvider - Class in com.ca.mas.foundation.auth
      -
      -
      The MASAuthenticationProvider class is a representation of a single provider.
      -
      -
      MASAuthenticationProvider(Provider) - Constructor for class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      MASAuthenticationProviders - Class in com.ca.mas.foundation.auth
      -
      -
      The MASAuthenticationProviders class is a representation of all available MASAuthenticationProvider
      -
      -
      MASAuthenticationProviders(AuthenticationProvider) - Constructor for class com.ca.mas.foundation.auth.MASAuthenticationProviders
      -
       
      -
      MASAuthenticator - Class in com.ca.mas.core.storage.sharedstorage
      -
       
      -
      MASAuthenticatorService - Class in com.ca.mas.core.storage.sharedstorage
      -
       
      -
      MASAuthenticatorService() - Constructor for class com.ca.mas.core.storage.sharedstorage.MASAuthenticatorService
      -
       
      -
      MASAuthorizationRequest - Class in com.ca.mas.foundation
      -
      -
      OAuth2 Authorization Request
      -
      -
      MASAuthorizationRequest.MASAuthorizationRequestBuilder - Class in com.ca.mas.foundation
      -
       
      -
      MASAuthorizationRequestBuilder() - Constructor for class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      MASAuthorizationRequestHandler - Interface in com.ca.mas.foundation
      -
      -
      Handle OAuth Authorization Code flow.
      -
      -
      MASAuthorizationResponse - Class in com.ca.mas.foundation
      -
      -
      Response to an authorization request - MASAuthenticationProviders.getAuthenticationProviders(MASCallback)
      -
      -
      MASAuthorizationResponse(String, String) - Constructor for class com.ca.mas.foundation.MASAuthorizationResponse
      -
       
      -
      MASCallback<T> - Class in com.ca.mas.foundation
      -
       
      -
      MASCallback() - Constructor for class com.ca.mas.foundation.MASCallback
      -
       
      -
      MASClaims - Interface in com.ca.mas.foundation
      -
      -
      An interface to get JWT claim values.
      -
      -
      MASClaimsBuilder - Class in com.ca.mas.foundation
      -
      -
      A builder to construct MASClaims objects.
      -
      -
      MASClaimsBuilder() - Constructor for class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Initialize a builder object.
      -
      -
      MASClaimsBuilder(MASClaims) - Constructor for class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Initialize a builder object with an existing MASClaims object.
      -
      -
      MASClaimsConstants - Class in com.ca.mas.foundation
      -
      -
      Registered claim names.
      -
      -
      MASConfiguration - Class in com.ca.mas.foundation
      -
       
      -
      MASConfiguration(Context) - Constructor for class com.ca.mas.foundation.MASConfiguration
      -
       
      -
      MASConnectionListener - Interface in com.ca.mas.foundation
      -
      -
      Interface that allows for implementing classes to listen for connection events.
      -
      -
      MASConstants - Class in com.ca.mas.foundation
      -
      -
      Contains enums for describing the grant flow and the SDK state.
      -
      -
      MASDevice - Class in com.ca.mas.foundation
      -
      -
      The MASDevice class is a local representation of device data.
      -
      -
      MASEmail - Class in com.ca.mas.identity.user
      -
       
      -
      MASEmail() - Constructor for class com.ca.mas.identity.user.MASEmail
      -
       
      -
      MASException - Class in com.ca.mas.foundation
      -
      -
      Encapsulates a general MAS error as an exception that returns to a MASCallback.onError(Throwable).
      -
      -
      MASException(Throwable) - Constructor for class com.ca.mas.foundation.MASException
      -
       
      -
      MASException(String, Throwable) - Constructor for class com.ca.mas.foundation.MASException
      -
       
      -
      MASExtension - Annotation Type in com.ca.mas.foundation
      -
       
      -
      MASFilteredRequest - Class in com.ca.mas.identity.common
      -
      -
      MASFilteredRequest describes the APIs for user's to specify scim filters.
      -
      -
      MASFilteredRequest(List<String>, String) - Constructor for class com.ca.mas.identity.common.MASFilteredRequest
      -
      -
      Constructor Type: Default no-args.
      - Description: Creates an object that initializes the class, only.
      -
      -
      MASFilteredRequestBuilder - Interface in com.ca.mas.identity.common
      -
      -
      MASFilteredRequestBuilder defines all of the SCIM operations that are available for SCIM queries.
      -
      -
      MASFilteredRequestBuilder.Logical - Enum in com.ca.mas.identity.common
      -
      -
      Description: The Logical enum are the SCIM logical operators as described in the - SCIM Protocol reference section {3.4.4.2 Filtering}.
      -
      -
      MASFilteredRequestBuilder.Operator - Enum in com.ca.mas.identity.common
      -
      -
      Description: The Operator enum are the SCIM binary and unary operators as described in the - SCIM Protocol reference section {3.4.4.2 Filtering}.
      -
      -
      MASFilteredRequestBuilder.SortOrder - Enum in com.ca.mas.identity.common
      -
      -
      Description: The SortOrder enum contains the sorting directives as described in the - SCIM Schema reference section {3.4.2.3 Sorting}.
      -
      -
      MASFoundationStrings - Class in com.ca.mas.foundation
      -
      -
      A class that contains user feedback messages.
      -
      -
      MASGrantFlow - Annotation Type in com.ca.mas.foundation
      -
       
      -
      MASGrantProvider - Enum in com.ca.mas.foundation
      -
      -
      Constant to define Grant Types
      -
      -
      MASGroup - Class in com.ca.mas.foundation
      -
      -
      The MASGroup class is a local representation of group data.
      -
      -
      MASGroup() - Constructor for class com.ca.mas.foundation.MASGroup
      -
       
      -
      MASGroupIdentity - Interface in com.ca.mas.identity.group
      -
      -
      This interface enables Identity Management features for the MASGroup object.
      -
      -
      MASGroupRepository - Interface in com.ca.mas.identity.group
      -
      -
      This interface enables Identity Management features for the MASGroup object.
      -
      -
      MASIdToken - Class in com.ca.mas.foundation
      -
      -
      ID token as described in ID Token - By default, the type would set to urn:ietf:params:oauth:grant-type:jwt-bearer
      -
      -
      MASIdToken.Builder - Class in com.ca.mas.foundation
      -
       
      -
      MASIms - Class in com.ca.mas.identity.user
      -
       
      -
      MASIms() - Constructor for class com.ca.mas.identity.user.MASIms
      -
       
      -
      MASInvalidHostException - Exception in com.ca.mas.foundation
      -
      -
      Thrown when an invalid host is identified.
      -
      -
      MASInvalidHostException(String) - Constructor for exception com.ca.mas.foundation.MASInvalidHostException
      -
       
      -
      MASInvalidHostException(String, Throwable) - Constructor for exception com.ca.mas.foundation.MASInvalidHostException
      -
       
      -
      MASMember - Class in com.ca.mas.identity.group
      -
      -
      MASMember is a thinly wrapped User that contains the type, value, ref, and display specific to a MASMember.
      -
      -
      MASMember(MASUser) - Constructor for class com.ca.mas.identity.group.MASMember
      -
      -
      Description: Convenience constructor to create a MASMember from a MASUser.
      -
      -
      MASMember(String, String, String, String) - Constructor for class com.ca.mas.identity.group.MASMember
      -
      -
      Description: Convenience constructor to create a MASMember from the IdentityBase attributes.
      -
      -
      MASMessage - Class in com.ca.mas.messaging
      -
      -
      The MASMessage data structure is used to send and receive messages from the MQTT message broker.
      -
      -
      MASMessage() - Constructor for class com.ca.mas.messaging.MASMessage
      -
       
      -
      MASMessage(Parcel) - Constructor for class com.ca.mas.messaging.MASMessage
      -
       
      -
      MASMessageException - Exception in com.ca.mas.messaging
      -
      -
      MASMessageException is a general exception wrapper used by the MAS SDK to - normalize protocol specific messaging implementations.
      -
      -
      MASMessageException() - Constructor for exception com.ca.mas.messaging.MASMessageException
      -
      -
      Description: No args constructor.
      -
      -
      MASMessageException(String) - Constructor for exception com.ca.mas.messaging.MASMessageException
      -
      -
      Description: Convenience constructor.
      -
      -
      MASMessageException(Throwable) - Constructor for exception com.ca.mas.messaging.MASMessageException
      -
      -
      Description: Convenience constructor.
      -
      -
      MASMessageException(String, Throwable) - Constructor for exception com.ca.mas.messaging.MASMessageException
      -
      -
      Description: Convenience constructor.
      -
      -
      MASMessagingSegment - Annotation Type in com.ca.mas.messaging.topic
      -
      -
      - Summary - - ValueDescription - - - MASConstants.MAS_USER,Subscribe/Publish message to user. - MASConstants.MAS_APPLICATIONSubscribe/Publish message to application. - MASConstants.MAS_USER | MASConstants.MAS_APPLICATIONSubscribe/Publish message to user and application. - -
      -
      -
      MASMessenger - Interface in com.ca.mas.messaging
      -
      -
      MASMessenger is an interface which enables messaging feature for the authenticated user.
      -
      -
      MASMeta - Class in com.ca.mas.identity.user
      -
      -
      The MASMeta class implements the SCIM resourceType meta attribute.
      -
      -
      MASMeta() - Constructor for class com.ca.mas.identity.user.MASMeta
      -
       
      -
      MASMultiFactorAuthenticator<T extends MASMultiFactorHandler> - Class in com.ca.mas.foundation
      -
      -
      Represents a multi-factor authenticator
      -
      -
      MASMultiFactorAuthenticator() - Constructor for class com.ca.mas.foundation.MASMultiFactorAuthenticator
      -
       
      -
      MASMultiFactorHandler - Class in com.ca.mas.foundation
      -
      -
      A Handler object to handle multi-factor authentication
      -
      -
      MASMultiFactorHandler(long) - Constructor for class com.ca.mas.foundation.MASMultiFactorHandler
      -
      -
      Create a MASMultiFactorHandler with the request ID.
      -
      -
      MASMultiFactorHandler(Parcel) - Constructor for class com.ca.mas.foundation.MASMultiFactorHandler
      -
       
      -
      MASName - Class in com.ca.mas.identity.user
      -
      -
      The MASName interface contains the common attribute name - components of the user's name.
      -
      -
      MASName() - Constructor for class com.ca.mas.identity.user.MASName
      -
       
      -
      MASName(String, String) - Constructor for class com.ca.mas.identity.user.MASName
      -
      -
      Convience constructor that takes the 2 components of the name that are the least likey to be null.
      -
      -
      MASOtpAuthenticationHandler - Class in com.ca.mas.foundation
      -
      -
      A Handler object to handle One Time Password multi-factor authentication
      -
      -
      MASOtpAuthenticationHandler(long, List<String>, boolean) - Constructor for class com.ca.mas.foundation.MASOtpAuthenticationHandler
      -
       
      -
      MASOtpAuthenticationHandler(Parcel) - Constructor for class com.ca.mas.foundation.MASOtpAuthenticationHandler
      -
       
      -
      MASOtpMultiFactorAuthenticator - Class in com.ca.mas.foundation
      -
      -
      One Time Password MultiFactorAuthenticator
      -
      -
      MASOtpMultiFactorAuthenticator() - Constructor for class com.ca.mas.foundation.MASOtpMultiFactorAuthenticator
      -
       
      -
      MASOwner - Class in com.ca.mas.identity.group
      -
      -
      MASOwner is a thinly wrapped User object that represents the one and only owner of an ad-hoc group.
      -
      -
      MASOwner(MASUser) - Constructor for class com.ca.mas.identity.group.MASOwner
      -
      -
      Description: Convenience constructor to create an MASOwner from a MASUser.
      -
      -
      MASOwner(String, String, String) - Constructor for class com.ca.mas.identity.group.MASOwner
      -
       
      -
      MASPagination - Interface in com.ca.mas.identity.common
      -
      -
      For example, to retrieve the first 10 Users, set the startIndex to 1 - and the count to 10:
      -
      -
      MASPayload - Interface in com.ca.mas.messaging
      -
      -
      MASPayload describes the message format that is passed between MAS clients.
      -
      -
      MASPhone - Class in com.ca.mas.identity.user
      -
       
      -
      MASPhone() - Constructor for class com.ca.mas.identity.user.MASPhone
      -
       
      -
      MASPhoto - Class in com.ca.mas.identity.user
      -
       
      -
      MASPhoto() - Constructor for class com.ca.mas.identity.user.MASPhoto
      -
       
      -
      MASProximityLogin - Interface in com.ca.mas.foundation.auth
      -
      -
      Provide a standard interface for Proximity Login
      -
      -
      MASProximityLoginBLE - Class in com.ca.mas.foundation.auth
      -
      -
      Proximity login with Bluetooth Low Energy (BLE)
      -
      -
      MASProximityLoginBLE(MASProximityLoginBLECentralListener) - Constructor for class com.ca.mas.foundation.auth.MASProximityLoginBLE
      -
       
      -
      MASProximityLoginBLECentralListener - Interface in com.ca.mas.foundation.auth
      -
      -
      Interface to receive State change or Error
      -
      -
      MASProximityLoginBLEPeripheralListener - Class in com.ca.mas.foundation.auth
      -
       
      -
      MASProximityLoginBLEPeripheralListener() - Constructor for class com.ca.mas.foundation.auth.MASProximityLoginBLEPeripheralListener
      -
       
      -
      MASProximityLoginBLEUserConsentHandler - Interface in com.ca.mas.foundation.auth
      -
       
      -
      MASProximityLoginNFC - Class in com.ca.mas.foundation.auth
      -
      -
      Proximity login with Near Field Communication (NFC).
      -
      -
      MASProximityLoginNFC() - Constructor for class com.ca.mas.foundation.auth.MASProximityLoginNFC
      -
       
      -
      MASProximityLoginQRCode - Class in com.ca.mas.foundation.auth
      -
      -
      Proximity login with Quick Response (QR) Code.
      -
      -
      MASProximityLoginQRCode() - Constructor for class com.ca.mas.foundation.auth.MASProximityLoginQRCode
      -
       
      -
      MASRequest - Interface in com.ca.mas.foundation
      -
      -
      An Http Api Request.
      -
      -
      MASRequest.MASRequestBuilder - Class in com.ca.mas.foundation
      -
      -
      Builder class to build MASRequest object
      -
      -
      MASRequest.Method - Enum in com.ca.mas.foundation
      -
       
      -
      MASRequestBody - Class in com.ca.mas.foundation
      -
       
      -
      MASRequestBody() - Constructor for class com.ca.mas.foundation.MASRequestBody
      -
       
      -
      MASRequestBuilder(URI) - Constructor for class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Create a builder with the provided URI.
      -
      -
      MASRequestBuilder(Uri) - Constructor for class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Create a builder with the provided Uri
      -
      -
      MASRequestBuilder(URL) - Constructor for class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Create a build with provided URL
      -
      -
      MASRequestBuilder(MASRequest) - Constructor for class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Convenience method for reconstructing a request as a builder
      -
      -
      MASResponse<T> - Interface in com.ca.mas.foundation
      -
       
      -
      MASResponseBody<T> - Class in com.ca.mas.foundation
      -
      -
      An API HTTP response body.
      -
      -
      MASResponseBody() - Constructor for class com.ca.mas.foundation.MASResponseBody
      -
       
      -
      MASSecurityConfiguration - Interface in com.ca.mas.foundation
      -
      -
      MASSecurityConfiguration class is an object that determines security measures for communication between the target host.
      -
      -
      MASSecurityConfiguration.Builder - Class in com.ca.mas.foundation
      -
       
      -
      MASServerException - Class in com.ca.mas.foundation
      -
      -
      MASServerException is a general exception wrapper used by the MAS SDK
      -
      -
      MASServerException(MASResponse, int, int, String, String) - Constructor for class com.ca.mas.foundation.MASServerException
      -
       
      -
      MASServerException(MASResponse, int, int, String, String, Throwable) - Constructor for class com.ca.mas.foundation.MASServerException
      -
       
      -
      MASServerException(MAGServerException) - Constructor for class com.ca.mas.foundation.MASServerException
      -
       
      -
      MASSessionUnlockCallback<T> - Class in com.ca.mas.foundation
      -
       
      -
      MASSessionUnlockCallback() - Constructor for class com.ca.mas.foundation.MASSessionUnlockCallback
      -
       
      -
      MASSharedStorage - Class in com.ca.mas.core.storage.sharedstorage
      -
      -
      MASSharedStorage is designed for developers to write, read, and delete String or byte[] data into - the AccountManager so that multiple applications signed with the same key and using the same - account name can share data.
      -
      -
      MASSharedStorage(String) - Constructor for class com.ca.mas.core.storage.sharedstorage.MASSharedStorage
      -
      -
      Creates or retrieves a MASSharedStorage with the specified name and account type.
      -
      -
      MASSharedStorageException - Exception in com.ca.mas.foundation
      -
      -
      Used for any issues encountered with creating the MASSharedStorage identifier.
      -
      -
      MASSharedStorageException(String) - Constructor for exception com.ca.mas.foundation.MASSharedStorageException
      -
       
      -
      MASSharedStorageException(String, Throwable) - Constructor for exception com.ca.mas.foundation.MASSharedStorageException
      -
       
      -
      MASState - Annotation Type in com.ca.mas.foundation
      -
      -
      - Summary - - ValueDescription - - - MASConstants.MAS_STATE_NOT_CONFIGUREDState that SDK has not been initialized and does not have configuration file. - MASConstants.MAS_STATE_NOT_INITIALIZEDState that SDK has the active configuration either in the local file system, but has not been initialized yet. - MASConstants.MAS_STATE_STARTEDState that SDK did start; at this state, SDK should be fully functional. - MASConstants.MAS_STATE_STOPPEDState that SDK did stop; at this state, SDK is properly stopped and should be able to re-start. - -
      -
      -
      MASStorageManager - Class in com.ca.mas.core.storage.implementation
      -
      -
      Factory that creates the the Storage instance.
      -
      -
      MASStorageManager() - Constructor for class com.ca.mas.core.storage.implementation.MASStorageManager
      -
       
      -
      MASStorageManager.MASStorageType - Enum in com.ca.mas.core.storage.implementation
      -
      -
      Types of storage.
      -
      -
      MASTokenRequest - Class in com.ca.mas.foundation
      -
       
      -
      MASTokenRequest() - Constructor for class com.ca.mas.foundation.MASTokenRequest
      -
       
      -
      MASTokenRequest(MASRequest) - Constructor for class com.ca.mas.foundation.MASTokenRequest
      -
       
      -
      MASTopic - Interface in com.ca.mas.messaging.topic
      -
      -
      The MASTopic interface enforces the topic properties available to the user.
      -
      -
      MASUser - Class in com.ca.mas.foundation
      -
      -
      The MASUser interface is a core interface used to represent a user in the system, - as well as an Identity Management definition used in the interaction with SCIM.
      -
      -
      MASUser() - Constructor for class com.ca.mas.foundation.MASUser
      -
       
      -
      MASUserIdentity - Interface in com.ca.mas.identity.user
      -
      -
      The MASUserIdentity interface enables the Identity Management feature for the authenticated user.
      -
      -
      MASUserRepository - Interface in com.ca.mas.identity.user
      -
      -
      The MASUserIdentity interface enables the Identity Management feature for the authenticated user.
      -
      -
      MASWebApplication - Class in com.ca.mas.foundation.auth
      -
      -
      The SDK uses WebView to display a Web browser application.
      -
      -
      MASWebApplication(WebView, String) - Constructor for class com.ca.mas.foundation.auth.MASWebApplication
      -
       
      -
      mAttributes - Variable in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      me(MASCallback<MASUser>) - Method in interface com.ca.mas.identity.user.MASUserRepository
      -
       
      -
      mExcludedAttributes - Variable in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      - - - -

      N

      -
      -
      newInstance() - Static method in class com.ca.mas.foundation.MASGroup
      -
       
      -
      newInstance() - Static method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      newInstance(Intent) - Static method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      notBeforeTime(Date) - Method in class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Sets the earliest processing time for the MASClaims object.
      -
      -
      notifyOnCancel() - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
       
      -
      notifyOnCancel() - Method in interface com.ca.mas.foundation.MASRequest
      -
      -
      Notify the MASCallback.onError(Throwable) when the request is cancelled by MAS.cancelRequest(long).
      -
      -
      - - - -

      O

      -
      -
      onAuthenticateRequest(Context, long, MASAuthenticationProviders) - Method in interface com.ca.mas.foundation.MASAuthenticationListener
      -
      -
      Notify the host application that a request to authenticate is triggered by the authentication process.
      -
      -
      onBind(Intent) - Method in class com.ca.mas.core.storage.sharedstorage.MASAuthenticatorService
      -
       
      -
      onConnected(HttpURLConnection) - Method in interface com.ca.mas.foundation.MASConnectionListener
      -
      -
      This method will be invoked after the HTTP request is prepared by the SDK.
      -
      -
      onConsentRequested(String, BluetoothLeConsentHandler) - Method in class com.ca.mas.foundation.auth.MASProximityLoginBLEPeripheralListener
      -
       
      -
      onConsentRequested(Context, String, MASProximityLoginBLEUserConsentHandler) - Method in class com.ca.mas.foundation.auth.MASProximityLoginBLEPeripheralListener
      -
      -
      Notify the host application that an consent request occurred while session - sharing.
      -
      -
      onError(Throwable) - Method in class com.ca.mas.foundation.MASCallback
      -
      -
      Called when an asynchronous call fails to complete.
      -
      -
      onMultiFactorAuthenticationRequest(Context, MASRequest, MASResponse<?>, T) - Method in class com.ca.mas.foundation.MASMultiFactorAuthenticator
      -
      -
      The method will be triggered when MASFoundation detects that the custom MFA class is responsible to handle MFA flow.
      -
      -
      onMultiFactorAuthenticationRequest(Context, MASRequest, MASResponse<?>, MASOtpAuthenticationHandler) - Method in class com.ca.mas.foundation.MASOtpMultiFactorAuthenticator
      -
       
      -
      onNativeAppLaunch(MASApplication) - Method in class com.ca.mas.foundation.auth.MASApplication.MASApplicationLauncher
      -
      -
      Notify the host application of a request to launch the native app.
      -
      -
      onObtained(HttpURLConnection) - Method in interface com.ca.mas.foundation.MASConnectionListener
      -
      -
      Invoke immediately after the call URL.openConnection().
      -
      -
      onOtpAuthenticateRequest(Context, MASOtpAuthenticationHandler) - Method in interface com.ca.mas.foundation.MASAuthenticationListener
      -
      -
      Notify the host application that a request to authenticate Otp is triggered by the authentication process.
      -
      -
      onSuccess(T) - Method in class com.ca.mas.foundation.MASCallback
      -
      -
      Called when an asynchronous call completes successfully.
      -
      -
      onUserAuthenticationRequired() - Method in class com.ca.mas.foundation.MASSessionUnlockCallback
      -
      -
      Called when an asynchronous call encounters a UserNotAuthenticatedException and requires - user authentication.
      -
      -
      onWebAppLaunch(MASApplication) - Method in class com.ca.mas.foundation.auth.MASApplication.MASApplicationLauncher
      -
      -
      Notify the host application of a request to launch the web app.
      -
      -
      - - - -

      P

      -
      -
      PAGE_INC_BY - Static variable in interface com.ca.mas.identity.common.MASPagination
      -
       
      -
      PAGE_NO_PAGINATION - Static variable in interface com.ca.mas.identity.common.MASPagination
      -
       
      -
      PAGE_START - Static variable in interface com.ca.mas.identity.common.MASPagination
      -
       
      -
      PAGE_START_EXP - Static variable in interface com.ca.mas.identity.common.MASPagination
      -
       
      -
      PAGE_START_INDEX - Static variable in interface com.ca.mas.identity.common.MASPagination
      -
       
      -
      password() - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Sets request grant type to MASGrantProvider.PASSWORD
      -
      -
      populate(JSONObject) - Method in class com.ca.mas.identity.user.MASAddress
      -
       
      -
      populate(JSONObject) - Method in class com.ca.mas.identity.user.MASEmail
      -
       
      -
      populate(JSONObject) - Method in class com.ca.mas.identity.user.MASMeta
      -
       
      -
      populate(JSONObject) - Method in class com.ca.mas.identity.user.MASName
      -
       
      -
      post(MASRequestBody) - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Sets the request method to POST with MASRequestBody
      -
      -
      proceed(Context, Map<String, String>) - Method in class com.ca.mas.foundation.MASMultiFactorHandler
      -
      -
      Proceeds with additional headers that can be injected to the original request.
      -
      -
      proceed(Context, String) - Method in class com.ca.mas.foundation.MASOtpAuthenticationHandler
      -
       
      -
      processPendingRequests() - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Requests that any pending queued requests be processed.
      -
      -
      put(MASRequestBody) - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Sets the request method to PUT with MASRequestBody
      -
      -
      - - - -

      R

      -
      -
      read(HttpURLConnection) - Method in class com.ca.mas.foundation.MASResponseBody
      -
      -
      Default implementation of reading the response body.
      -
      -
      registerMultiFactorAuthenticator(MASMultiFactorAuthenticator) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Static method to register custom MASMultiFactorAuthenticator object to handle multi-factor authentication.
      -
      -
      REGISTRATION_TYPE - Static variable in interface com.ca.mas.foundation.MASAuthCredentials
      -
       
      -
      removeHeader(String) - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Removes the specified header from the request.
      -
      -
      removeMember(MASMember) - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Description: remove member from the group.
      -
      -
      removeSecurityConfiguration(Uri) - Method in class com.ca.mas.foundation.MASConfiguration
      -
      -
      Attempts to remove the security configuration from the list of configurations - with the host and port information and notifies observers.
      -
      -
      removeSessionLock(MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
      -
      Removes the secured ID token.
      -
      -
      render() - Method in interface com.ca.mas.foundation.auth.MASProximityLogin
      -
      -
      Render the view for the Proximity login, the view can be a image, button or null for no view.
      -
      -
      render() - Method in class com.ca.mas.foundation.auth.MASProximityLoginNFC
      -
       
      -
      renderEnterpriseIcon(ImageView) - Method in class com.ca.mas.foundation.auth.MASApplication
      -
      -
      The application icon is downloaded with the provided URL from MASApplication.getIconUrl() - and cached into memory for performance improvement.
      -
      -
      RequestCancelledException(Bundle) - Constructor for exception com.ca.mas.foundation.MAS.RequestCancelledException
      -
       
      -
      requestUserInfo(MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
      -
      Requesting userInfo for the MASUser object
      -
      -
      resetLocally() - Method in class com.ca.mas.foundation.MASDevice
      -
      -
      Resets the application’s locally stored data on the device only.
      -
      -
      responseBody(MASResponseBody) - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Sets the type of parsed response.
      -
      -
      retrieveEnterpriseApps(MASCallback<List<MASApplication>>) - Static method in class com.ca.mas.foundation.auth.MASApplication
      -
      -
      The MAG administrator creates a JSON-formatted list of native or non-native applications.
      -
      -
      - - - -

      S

      -
      -
      save(String, String) - Method in class com.ca.mas.core.storage.sharedstorage.MASSharedStorage
      -
      -
      Saves a string value with the given key into the shared storage.
      -
      -
      save(String, byte[]) - Method in class com.ca.mas.core.storage.sharedstorage.MASSharedStorage
      -
      -
      Saves a byte array with the given key into the shared storage.
      -
      -
      save(MASCallback<MASGroup>) - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Saves the group object in the cloud.
      -
      -
      save(MASGroup, MASCallback<MASGroup>) - Method in interface com.ca.mas.identity.group.MASGroupRepository
      -
       
      -
      ScimUser - Interface in com.ca.mas.identity.user
      -
       
      -
      scope(String) - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Sets the request grant scope; use a space delimiter for more than one scope, e.g.
      -
      -
      SDK_UNINITIALIZED - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      SECURE_LOCK_FAILED_TO_DELETE_ID_TOKEN - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      SECURE_LOCK_FAILED_TO_DELETE_SECURE_ID_TOKEN - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      SECURE_LOCK_FAILED_TO_RETRIEVE_ID_TOKEN - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      SECURE_LOCK_FAILED_TO_SAVE_ID_TOKEN - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      SECURE_LOCK_FAILED_TO_SAVE_SECURE_ID_TOKEN - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      SECURE_LOCK_SESSION_CURRENTLY_LOCKED - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      SECURITY_CONFIGURATION_CHANGED - Static variable in class com.ca.mas.foundation.MASConfiguration
      -
       
      -
      SECURITY_CONFIGURATION_RESET - Static variable in class com.ca.mas.foundation.MASConfiguration
      -
       
      -
      send(MssoContext) - Method in class com.ca.mas.foundation.MASTokenRequest
      -
       
      -
      sendMessage(MASTopic, MASMessage, MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      sendMessage(MASMessage, MASUser, MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      sendMessage(MASMessage, MASUser, String, MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      sendMessage(MASMessage, MASGroup, MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      sendMessage(MASMessage, MASGroup, String, MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      sendMessage(MASTopic, MASMessage, MASCallback<Void>) - Method in interface com.ca.mas.messaging.MASMessenger
      -
      -
      This method sends a message from the current user to a topic.
      -
      -
      sendMessage(MASMessage, MASUser, MASCallback<Void>) - Method in interface com.ca.mas.messaging.MASMessenger
      -
      -
      This method sends a message from the current user to an existing user.
      -
      -
      sendMessage(MASMessage, MASUser, String, MASCallback<Void>) - Method in interface com.ca.mas.messaging.MASMessenger
      -
      -
      This method sends a message from the current user to an existing user on a specified topic.
      -
      -
      sendMessage(MASMessage, MASGroup, MASCallback<Void>) - Method in interface com.ca.mas.messaging.MASMessenger
      -
      -
      This method sends a message from the current user to an existing group.
      -
      -
      sendMessage(MASMessage, MASGroup, String, MASCallback<Void>) - Method in interface com.ca.mas.messaging.MASMessenger
      -
      -
      This method sends a message from the current user to an existing group on a specified topic.
      -
      -
      setApplicationLauncher(MASApplication.MASApplicationLauncher) - Static method in class com.ca.mas.foundation.auth.MASApplication
      -
      -
      Set the Application Launcher to launch the Native App and Web App, MASApplication.MASApplicationLauncher.onNativeAppLaunch(MASApplication) - is triggered for Native App and MASApplication.MASApplicationLauncher.onWebAppLaunch(MASApplication) for Web App.
      -
      -
      setAttributes(List<String>) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      setAttributes(List<String>) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Pre-Conditions: None.
      - Description: The list of attributes that should be returned in the result.
      -
      -
      setAuthenticationListener(MASAuthenticationListener) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Set a user login listener to handle user authentication.
      -
      -
      setCertificateAdvancedRenewTimeframe(int) - Method in class com.ca.mas.foundation.MASConfiguration
      -
       
      -
      setClientId(String) - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      setConfigurationFileName(String) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Sets the name of the configuration file.
      -
      -
      setConnectionListener(MASConnectionListener) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Sets a listener to listen for connection events.
      -
      -
      setContentEncoding(String) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setContentEncoding(String) - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: The payload's content encoding.
      -
      -
      setContentType(String) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setContentType(String) - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: Set the {IANA MIME} media type.
      -
      -
      setCountry(String) - Method in class com.ca.mas.identity.user.MASAddress
      -
      -
      Description: Setter for the user's country associated with this address.
      -
      -
      setDisplay(String) - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      setDisplay(String) - Method in class com.ca.mas.identity.group.MASMember
      -
      -
      Description: Setter
      -
      -
      setDuplicate(boolean) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setExcludedAttributes(List<String>) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      setExcludedAttributes(List<String>) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Pre-Conditions: None.
      - Description: The list of attributes that should NOT be returned in the result.
      -
      -
      setGrantFlow(int) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Sets the grant type property.
      -
      -
      setGroupName(String) - Method in class com.ca.mas.foundation.MASGroup
      -
      -
      Description: The groupName is stored as the 'displayName' in the SCIM data model.
      -
      -
      setPagination(int, int) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      setPagination(int, int) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Pre-Conditions: None.
      - Description: Set the pagination start and the number of results per page.
      -
      -
      setPayload(byte[]) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setPayload(byte[]) - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: This payload is a byte stream that is meaningful to the receiving client.
      -
      -
      setPublic() - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      The request is being made outside of primary gateway.
      -
      -
      setQos(int) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setRedirectUri(Uri) - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      setRef(String) - Method in class com.ca.mas.identity.group.MASMember
      -
      -
      Description: Setter.
      -
      -
      setResponseType(String) - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      setRetained(boolean) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setScope(String) - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      setSenderId(String) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setSenderId(String) - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: The Id of the sender from the MASUser instance.
      -
      -
      setSenderType(String) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setSenderType(String) - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: Set the sender type that has context within the implementing application.
      -
      -
      setSentTime(long) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setSentTime(long) - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: The number of milliseconds since the Epoch returned by an OS call to getTime, for example.
      -
      -
      setSortOrder(MASFilteredRequestBuilder.SortOrder, String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      setSortOrder(MASFilteredRequestBuilder.SortOrder, String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter sortBy = attribute&sortOrder=ascending.
      -
      -
      setState(String) - Method in class com.ca.mas.foundation.MASAuthorizationRequest.MASAuthorizationRequestBuilder
      -
       
      -
      setTopic(String) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setType(String) - Method in class com.ca.mas.identity.group.MASMember
      -
      -
      Description: Setter.
      -
      -
      setValue(String) - Method in class com.ca.mas.identity.group.MASMember
      -
      -
      Description: Setter.
      -
      -
      setVersion(String) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      setVersion(String) - Method in interface com.ca.mas.messaging.MASPayload
      -
      -
      Description: The version will always be 1.0.
      -
      -
      SHARED_STORAGE_NULL_ACCOUNT_NAME - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      SHARED_STORAGE_NULL_ACCOUNT_TYPE - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      sign(MASClaims) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Signs the provided JWT MASClaims object with the device registered private key using SHA-256 hash algorithm - and injects JWT claims based on the user information.
      -
      -
      sign(MASClaims, PrivateKey) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Signs the provided JWT MASClaims object with the provided RSA private key using SHA-256 hash algorithm - and injects JWT claims based on the user information.
      -
      -
      sign() - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Signs the request with the device registered private key and injects JWT claims based on the user information.
      -
      -
      sign(MASClaims) - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Signs the request with the device registered private key and injects JWT claims based on the user information.
      -
      -
      sign(PrivateKey) - Method in class com.ca.mas.foundation.MASRequest.MASRequestBuilder
      -
      -
      Signs the request with the provided private key and injects JWT claims based on the user information.
      -
      -
      SORT_BY - Static variable in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
       
      -
      SORT_ORDER - Static variable in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
       
      -
      start() - Method in interface com.ca.mas.foundation.auth.MASProximityLogin
      -
      -
      Start the Proximity Login process
      -
      -
      start() - Method in class com.ca.mas.foundation.auth.MASProximityLoginBLE
      -
       
      -
      start() - Method in class com.ca.mas.foundation.auth.MASProximityLoginNFC
      -
       
      -
      start() - Method in class com.ca.mas.foundation.auth.MASProximityLoginQRCode
      -
       
      -
      start(Context) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Starts the lifecycle of the MAS processes.
      -
      -
      start(Context, boolean) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Starts the lifecycle of the MAS processes.
      -
      -
      start(Context, JSONObject) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Starts the lifecycle of the MAS processes with the given JSON configuration data.
      -
      -
      start(Context, URL) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Starts the lifecycle of the MAS processes with given JSON configuration file path.
      -
      -
      start(Context, URL, MASCallback<Void>) - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Starts the lifecycle of the MAS processes with given JSON configuration enrolment URL or null.
      -
      -
      startAsBluetoothPeripheral(MASProximityLoginBLEPeripheralListener) - Method in class com.ca.mas.foundation.MASDevice
      -
      -
      This method is used by a device to start a BLE session sharing in a peripheral role.
      -
      -
      startListeningToMyMessages(MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      startListeningToMyMessages(MASCallback<Void>) - Method in interface com.ca.mas.messaging.MASMessenger
      -
      -
      This method enables incoming messages to the currently authenticated user.
      -
      -
      startsWith(String, String) - Method in class com.ca.mas.identity.common.MASFilteredRequest
      -
       
      -
      startsWith(String, String) - Method in interface com.ca.mas.identity.common.MASFilteredRequestBuilder
      -
      -
      Description: This method applies the filter attribute sw filterValue.
      -
      -
      stop() - Method in interface com.ca.mas.foundation.auth.MASProximityLogin
      -
      -
      Stop the Proximity Login process
      -
      -
      stop() - Method in class com.ca.mas.foundation.auth.MASProximityLoginBLE
      -
       
      -
      stop() - Method in class com.ca.mas.foundation.auth.MASProximityLoginNFC
      -
       
      -
      stop() - Method in class com.ca.mas.foundation.auth.MASProximityLoginQRCode
      -
       
      -
      stop() - Static method in class com.ca.mas.foundation.MAS
      -
      -
      Stops the lifecycle of all MAS processes.
      -
      -
      stopAsBluetoothPeripheral() - Method in class com.ca.mas.foundation.MASDevice
      -
      -
      Stops the device acting as a bluetooth peripheral.
      -
      -
      stopListeningToMyMessages(MASCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
       
      -
      stopListeningToMyMessages(MASCallback<Void>) - Method in interface com.ca.mas.messaging.MASMessenger
      -
      -
      This method disables incoming messages to the currently authenticated user.
      -
      -
      stringBody(String) - Static method in class com.ca.mas.foundation.MASRequestBody
      -
       
      -
      stringBody() - Static method in class com.ca.mas.foundation.MASResponseBody
      -
       
      -
      subject(String) - Method in class com.ca.mas.foundation.MASClaimsBuilder
      -
      -
      Sets the subject for the MASClaims object.
      -
      -
      - - - -

      T

      -
      -
      TAG - Static variable in class com.ca.mas.foundation.MAS
      -
       
      -
      TOKEN_ID_EXPIRED - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      toString() - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      trustPublicPKI(boolean) - Method in class com.ca.mas.foundation.MASSecurityConfiguration.Builder
      -
      -
      Determines whether or not to validate the server trust against Android's trusted root certificates.
      -
      -
      trustPublicPki() - Method in interface com.ca.mas.foundation.MASSecurityConfiguration
      -
       
      -
      type(String) - Method in class com.ca.mas.foundation.MASIdToken.Builder
      -
       
      -
      - - - -

      U

      -
      -
      unlockSession(MASSessionUnlockCallback<Void>) - Method in class com.ca.mas.foundation.MASUser
      -
      -
      Triggers the Android unlock and captures the unlock result.
      -
      -
      updateCredentials(AccountAuthenticatorResponse, Account, String, Bundle) - Method in class com.ca.mas.core.storage.sharedstorage.MASAuthenticator
      -
       
      -
      urlEncodedFormBody(List<? extends Pair<String, String>>) - Static method in class com.ca.mas.foundation.MASRequestBody
      -
       
      -
      USER_NOT_CURRENTLY_AUTHENTICATED - Static variable in class com.ca.mas.foundation.MASFoundationStrings
      -
       
      -
      - - - -

      V

      -
      -
      value(String) - Method in class com.ca.mas.foundation.MASIdToken.Builder
      -
       
      -
      valueOf(String) - Static method in enum com.ca.mas.core.storage.implementation.MASStorageManager.MASStorageType
      -
      -
      Returns the enum constant of this type with the specified name.
      -
      -
      valueOf(String) - Static method in enum com.ca.mas.foundation.MASGrantProvider
      -
      -
      Returns the enum constant of this type with the specified name.
      -
      -
      valueOf(String) - Static method in enum com.ca.mas.foundation.MASRequest.Method
      -
      -
      Returns the enum constant of this type with the specified name.
      -
      -
      valueOf(String) - Static method in enum com.ca.mas.identity.common.MASFilteredRequestBuilder.Logical
      -
      -
      Returns the enum constant of this type with the specified name.
      -
      -
      valueOf(String) - Static method in enum com.ca.mas.identity.common.MASFilteredRequestBuilder.Operator
      -
      -
      Returns the enum constant of this type with the specified name.
      -
      -
      valueOf(String) - Static method in enum com.ca.mas.identity.common.MASFilteredRequestBuilder.SortOrder
      -
      -
      Returns the enum constant of this type with the specified name.
      -
      -
      values() - Static method in enum com.ca.mas.core.storage.implementation.MASStorageManager.MASStorageType
      -
      -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
      values() - Static method in enum com.ca.mas.foundation.MASGrantProvider
      -
      -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
      values() - Static method in enum com.ca.mas.foundation.MASRequest.Method
      -
      -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
      values() - Static method in enum com.ca.mas.identity.common.MASFilteredRequestBuilder.Logical
      -
      -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
      values() - Static method in enum com.ca.mas.identity.common.MASFilteredRequestBuilder.Operator
      -
      -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
      values() - Static method in enum com.ca.mas.identity.common.MASFilteredRequestBuilder.SortOrder
      -
      -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
      - - - -

      W

      -
      -
      write(OutputStream) - Method in class com.ca.mas.foundation.MASRequestBody
      -
      -
      Writing data to the http url connection, the output stream is retrieved by - URLConnection.getOutputStream()
      -
      -
      writeToParcel(Parcel, int) - Method in class com.ca.mas.foundation.auth.MASAuthenticationProvider
      -
       
      -
      writeToParcel(Parcel, int) - Method in class com.ca.mas.foundation.auth.MASAuthenticationProviders
      -
       
      -
      writeToParcel(Parcel, int) - Method in class com.ca.mas.foundation.MASAuthCredentialsAuthorizationCode
      -
       
      -
      writeToParcel(Parcel, int) - Method in class com.ca.mas.foundation.MASAuthCredentialsClientCredentials
      -
       
      -
      writeToParcel(Parcel, int) - Method in class com.ca.mas.foundation.MASAuthCredentialsJWT
      -
       
      -
      writeToParcel(Parcel, int) - Method in class com.ca.mas.foundation.MASAuthCredentialsPassword
      -
       
      -
      writeToParcel(Parcel, int) - Method in class com.ca.mas.foundation.MASMultiFactorHandler
      -
       
      -
      writeToParcel(Parcel, int) - Method in class com.ca.mas.foundation.MASOtpAuthenticationHandler
      -
       
      -
      writeToParcel(Parcel, int) - Method in class com.ca.mas.messaging.MASMessage
      -
       
      -
      -A B C D E F G H I J L M N O P R S T U V W 
      - -
      - - -
      Skip navigation links
      - - - - -
      -
      -
        -
      • Prev
        • -
      • Next
        • -
      - - -
      - -
      - - -
      - - - diff --git a/source/MASFoundation.Android/JavaDocs/index.html b/source/MASFoundation.Android/JavaDocs/index.html index 88509b17..64042935 100644 --- a/source/MASFoundation.Android/JavaDocs/index.html +++ b/source/MASFoundation.Android/JavaDocs/index.html @@ -2,8 +2,8 @@ - -mas-foundation API + +Generated Documentation (Untitled) @@ -13,15 +13,56 @@

      Packages

       

      diff --git a/source/MASFoundation.Android/JavaDocs/overview-summary.html b/source/MASFoundation.Android/JavaDocs/overview-summary.html index 38a13c3f..73d72ce3 100644 --- a/source/MASFoundation.Android/JavaDocs/overview-summary.html +++ b/source/MASFoundation.Android/JavaDocs/overview-summary.html @@ -2,9 +2,9 @@ - -Overview (mas-foundation API) - + +Overview + @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@ @@ -12,7 +12,7 @@