Package net.worcade.client.api
Interface ApplicationApi
-
- All Superinterfaces:
ApiKeysApi,OptionalFieldsApi,RemoteIdsApi
public interface ApplicationApi extends ApiKeysApi, RemoteIdsApi
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description Result<?>addVersions(String id, String... versions)Result<? extends Reference>create(ApplicationModification subject)Create a new Application.ApplicationCreatecreateBuilder()Result<CreateWithApiKey>createWithApiKey(ApplicationModification subject, String apiKeyDescription)static KeyPairgenerateKeyPair()Helper method to generate a proper keypair used for application authentication.Result<? extends Application>get(String id)Result<? extends Collection<? extends Reference>>getByFingerprint(String fingerprint)Result<? extends ApplicationProfile>getProfile(String id)Result<PublicKey>setupKeyExchange(String id, PublicKey applicationKey)Result<?>updateProfile(ApplicationModification subject)-
Methods inherited from interface net.worcade.client.api.mixin.ApiKeysApi
createApiKey, getApiKeys, removeApiKey
-
Methods inherited from interface net.worcade.client.api.mixin.OptionalFieldsApi
addOptionalFields, getOptionalFields, removeOptionalFields
-
Methods inherited from interface net.worcade.client.api.mixin.RemoteIdsApi
addRemoteIds, removeRemoteIds, searchByRemoteId
-
-
-
-
Method Detail
-
createBuilder
ApplicationCreate createBuilder()
-
get
Result<? extends Application> get(String id)
-
getProfile
Result<? extends ApplicationProfile> getProfile(String id)
-
create
Result<? extends Reference> create(ApplicationModification subject)
Create a new Application. Use thecreateBuilder()method for a new, empty template.
-
createWithApiKey
Result<CreateWithApiKey> createWithApiKey(ApplicationModification subject, String apiKeyDescription)
-
updateProfile
Result<?> updateProfile(ApplicationModification subject)
-
getByFingerprint
Result<? extends Collection<? extends Reference>> getByFingerprint(String fingerprint)
-
generateKeyPair
static KeyPair generateKeyPair() throws NoSuchAlgorithmException
Helper method to generate a proper keypair used for application authentication. Keep the private key somewhere safe, and send the public key to Worcade usingsetupKeyExchange(String, PublicKey)- Returns:
- a securely generated key pair
- Throws:
NoSuchAlgorithmException- if there's no provider for the RSA algorithm
-
-