com.ibm.mfp.server.app.external

Class ApplicationKey

java.lang.Object

com.ibm.mfp.server.app.external.ApplicationKey

public class ApplicationKey
extends java.lang.Object

Mobile application key.

Constructor Summary

Constructors

Constructor and Description
ApplicationKey()
ApplicationKey(java.lang.String clientPlatform, java.lang.String applicationId)
ApplicationKey(java.lang.String clientPlatform, java.lang.String applicationId, java.lang.String version)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getClientPlatform() Gets the name of the client platform (ios, android, etc)
java.lang.String	getId() Gets the application ID.
java.lang.String	getVersion() Gets the version of the application.
static ApplicationKey	parse(java.lang.String keyStr)
java.lang.String	toUniqueString() Gets a string represntation of the application key.
boolean	updateFrom(ApplicationKey that) Reserved for internal use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationKey

public ApplicationKey()

ApplicationKey

public ApplicationKey(java.lang.String clientPlatform,
              java.lang.String applicationId)

ApplicationKey

public ApplicationKey(java.lang.String clientPlatform,
              java.lang.String applicationId,
              java.lang.String version)

Method Detail

parse

public static ApplicationKey parse(java.lang.String keyStr)

getId

public java.lang.String getId()

Gets the application ID.

Returns:

the application ID

getClientPlatform

public java.lang.String getClientPlatform()

Gets the name of the client platform (ios, android, etc)

Returns:

the name of the client platform

getVersion

public java.lang.String getVersion()

Gets the version of the application.

Returns:

the application version

toUniqueString

public java.lang.String toUniqueString()

Gets a string represntation of the application key.

Returns:

a string represntation of the application key

updateFrom

public boolean updateFrom(ApplicationKey that)
                   throws java.lang.Exception

Reserved for internal use only.

Parameters:

that - the application key to update from

Returns:

true if this key was updated, false if it remains the same

Throws:

java.lang.Exception - if the given key is incompatible with this key

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object