co.codewizards.cloudstore.core.appid

Interface AppId

All Known Implementing Classes:

CloudStoreAppId

public interface AppId

Service providing the identity of the currently running application.

CloudStore might be used as the base for another application, i.e. as a library. In this case, the identity of this other application should use consistent file and directory names, e.g. for its configuration. So for example, the configuration directory "~/.cloudstore" should be "~/.myapp" instead.

Additionally, the auto-update must use a different web-site.

Therefore, the other application should implement an AppId with a higher priority than the CloudStoreAppId (having the negative priority -100).

Author:

Marco หงุ่ยตระกูล-Schulze - marco at codewizards dot co

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the name used by humans.
int	getPriority() Gets the priority of this AppId implementation.
String	getQualifiedId() Gets the qualified (long) ID.
String	getSimpleId() Gets the simple (short) ID without any qualifier prefix.
String	getWebSiteBaseUrl() Gets the base-URL.

Method Detail

getPriority

int getPriority()

Gets the priority of this AppId implementation. The AppIdRegistry chooses the AppId with the highest priority (the greatest number).

Returns:

the priority of this AppId implementation.

getSimpleId

String getSimpleId()

Gets the simple (short) ID without any qualifier prefix.

Example: "cloudstore"

Returns:

the simple (short) ID without any qualifier prefix. Never null.

getQualifiedId

String getQualifiedId()

Gets the qualified (long) ID.

Example: "co.codewizards.cloudstore"

Returns:

the qualified (long) ID. Never null.

getName

String getName()

Gets the name used by humans.

Example: "CloudStore"

Returns:

the name used by humans. Never null.

getWebSiteBaseUrl

String getWebSiteBaseUrl()

Gets the base-URL. Certain sub-URLs are expected beneath it.

Important: This URL must end on '/'!

Example: "http://cloudstore.codewizards.co/" (one of the expected sub-URLs is "http://cloudstore.codewizards.co/update/" where meta-data about the current version is expected).

Returns:

the base-URL (ending on '/'). Never null.