public abstract class

StormpathModule

extends Object
java.lang.Object
   ↳ org.mule.modules.stormpath.StormpathModule
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Stormpath Connector.

{@sample.config INCLUDE_ERROR}

Summary

Fields
private String apiKeyId The API key ID used to authenticate to Stormpath.
private String apiKeySecret The API key secret used to authenticate to Stormpath.
private String authorization
Public Constructors
StormpathModule()
Public Methods
abstract LoginSuccess attemptLogin(String applicationId, LoginAttempt loginAttempt)
Attempt a login with the provided credentials.
abstract Account createAccount(String directoryId, Account account)
Create an account.
abstract AccountStoreMapping createAccountStoreMapping(AccountStoreMapping accountStoreMapping)
Create an account store mapping.
abstract Application createApplication(Application application, boolean createDirectory)
Create an application.
abstract Directory createDirectory(Directory directory)
Create a directory.
abstract Group createGroup(String directoryId, Group group)
Create a group in a directory.
abstract GroupMembership createGroupMembership(GroupMembership groupMembership)
Add an account to a group.
abstract PasswordResetToken createPasswordResetToken(String applicationId, Email email)
Create a new password reset token for the provided email.
abstract void deleteAccount(String accountId)
Delete an account.
abstract void deleteAccountStoreMapping(String accountStoreMappingId)
Delete an account store mapping.
abstract void deleteApplication(String applicationId)
Delete an application.
abstract void deleteDirectory(String directoryId)
Delete a directory.
abstract void deleteGroup(String groupId)
Delete a group.
abstract void deleteGroupMembership(String groupMembershipId)
Remove an account from a group.
String getApiKeyId()
String getApiKeySecret()
String getAuthorization()
abstract Account readAccount(String accountId)
Read an account.
abstract Groups readAccountGroups(String accountId, Integer offset, Integer limit)
Read a paginated list of groups that belong to an account.
abstract AccountStoreMapping readAccountStoreMapping(String accountStoreMappingId)
Read an account store mapping.
abstract AccountStoreMappings readAccountStoreMappings(String applicationId)
Read the account store mappings for an application.
abstract Application readApplication(String applicationId)
Read an application.
abstract Accounts readApplicationAccounts(String applicationId, Integer offset, Integer limit)
Read a paginated list of accounts that belong to an application.
abstract Directory readDirectory(String directoryId)
Read a directory.
abstract Accounts readDirectoryAccounts(String directoryId, Integer offset, Integer limit)
Read a paginated list of accounts that belong to a directory.
abstract Groups readDirectoryGroups(String directoryId, Integer offset, Integer limit)
Read a paginated list of groups that belong to a directory.
abstract Group readGroup(String groupId)
Read a group.
abstract Accounts readGroupAccounts(String groupId, Integer offset, Integer limit)
Read a paginated list of accounts that belong to a group.
abstract PasswordResetToken readPasswordResetToken(String applicationId, String passwordResetTokenId)
Read an existing password reset token.
abstract Tenant readTenant(String tenantId)
Read a tenant.
abstract Applications readTenantApplications(String tenantId, Integer offset, Integer limit)
Read a paginated list of applications that belong to a tenant.
abstract Directories readTenantDirectories(String tenantId, Integer offset, Integer limit)
Read a paginated list of directories that belong to a tenant.
void setApiKeyId(String apiKeyId)
void setApiKeySecret(String apiKeySecret)
abstract Account updateAccount(String accountId, Account account)
Update an account.
abstract AccountStoreMapping updateAccountStoreMapping(String accountStoreMappingId, AccountStoreMapping accountStoreMapping)
Update an account store mapping.
abstract Application updateApplication(String applicationId, Application application)
Update an application.
abstract Directory updateDirectory(String directoryId, Directory directory)
Update a directory.
abstract Group updateGroup(String groupId, Group group)
Update a group.
abstract Tenant updateTenant(String tenantId, Tenant tenant)
Update a tenant.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private String apiKeyId

The API key ID used to authenticate to Stormpath.

private String apiKeySecret

The API key secret used to authenticate to Stormpath.

private String authorization

Public Constructors

public StormpathModule ()

Public Methods

public abstract LoginSuccess attemptLogin (String applicationId, LoginAttempt loginAttempt)

Attempt a login with the provided credentials.

Parameters
applicationId The unique identifier of the application.
loginAttempt A LoginAttempt instance.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Account createAccount (String directoryId, Account account)

Create an account.

Parameters
directoryId The unique identifier of the directory.
account The Account to create.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract AccountStoreMapping createAccountStoreMapping (AccountStoreMapping accountStoreMapping)

Create an account store mapping.

Parameters
accountStoreMapping An AccountStoreMapping to create.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Application createApplication (Application application, boolean createDirectory)

Create an application.

Parameters
application The Application to create.
createDirectory Define if a directory should be created and associated with the new application.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Directory createDirectory (Directory directory)

Create a directory.

Parameters
directory The Directory to create.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Group createGroup (String directoryId, Group group)

Create a group in a directory.

Parameters
directoryId The unique identifier of the directory.
group The Group to create.
Returns
  • a newly created Group instance.
Throws
IOException if anything goes wrong with the operation.

public abstract GroupMembership createGroupMembership (GroupMembership groupMembership)

Add an account to a group.

Parameters
groupMembership A GroupMembership instance that specifies the account and group to link.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract PasswordResetToken createPasswordResetToken (String applicationId, Email email)

Create a new password reset token for the provided email.

Parameters
applicationId The unique identifier of the application.
email An Email instance.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract void deleteAccount (String accountId)

Delete an account.

Parameters
accountId The unique identifier of the account.
Throws
IOException if anything goes wrong with the operation.

public abstract void deleteAccountStoreMapping (String accountStoreMappingId)

Delete an account store mapping.

Parameters
accountStoreMappingId The unique identifier of the account store mapping.
Throws
IOException if anything goes wrong with the operation.

public abstract void deleteApplication (String applicationId)

Delete an application.

Parameters
applicationId The unique identifier of the application.
Throws
IOException if anything goes wrong with the operation.

public abstract void deleteDirectory (String directoryId)

Delete a directory.

Parameters
directoryId The unique identifier of the directory.
Throws
IOException if anything goes wrong with the operation.

public abstract void deleteGroup (String groupId)

Delete a group.

Parameters
groupId The unique identifier of the group.
Throws
IOException if anything goes wrong with the operation.

public abstract void deleteGroupMembership (String groupMembershipId)

Remove an account from a group.

Parameters
groupMembershipId The unique identifier of the group membership.
Throws
IOException if anything goes wrong with the operation.

public String getApiKeyId ()

public String getApiKeySecret ()

public String getAuthorization ()

public abstract Account readAccount (String accountId)

Read an account.

Parameters
accountId The unique identifier of the account.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Groups readAccountGroups (String accountId, Integer offset, Integer limit)

Read a paginated list of groups that belong to an account.

Parameters
accountId The unique identifier of the account.
offset The zero-based starting index in the entire collection of the first item to return.
limit The maximum number of collection items to return for a single request.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract AccountStoreMapping readAccountStoreMapping (String accountStoreMappingId)

Read an account store mapping.

Parameters
accountStoreMappingId The unique identifier of the account store mapping.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract AccountStoreMappings readAccountStoreMappings (String applicationId)

Read the account store mappings for an application.

Parameters
applicationId The unique identifier of the application.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Application readApplication (String applicationId)

Read an application.

Parameters
applicationId The unique identifier of the application.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Accounts readApplicationAccounts (String applicationId, Integer offset, Integer limit)

Read a paginated list of accounts that belong to an application.

Parameters
applicationId The unique identifier of the application.
offset The zero-based starting index in the entire collection of the first item to return.
limit The maximum number of collection items to return for a single request.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Directory readDirectory (String directoryId)

Read a directory.

Parameters
directoryId The unique identifier of the directory.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Accounts readDirectoryAccounts (String directoryId, Integer offset, Integer limit)

Read a paginated list of accounts that belong to a directory.

Parameters
directoryId The unique identifier of the directory.
offset The zero-based starting index in the entire collection of the first item to return.
limit The maximum number of collection items to return for a single request.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Groups readDirectoryGroups (String directoryId, Integer offset, Integer limit)

Read a paginated list of groups that belong to a directory.

Parameters
directoryId The unique identifier of the directory.
offset The zero-based starting index in the entire collection of the first item to return.
limit The maximum number of collection items to return for a single request.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Group readGroup (String groupId)

Read a group.

Parameters
groupId The unique identifier of the group.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Accounts readGroupAccounts (String groupId, Integer offset, Integer limit)

Read a paginated list of accounts that belong to a group.

Parameters
groupId The unique identifier of the group.
offset The zero-based starting index in the entire collection of the first item to return.
limit The maximum number of collection items to return for a single request.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract PasswordResetToken readPasswordResetToken (String applicationId, String passwordResetTokenId)

Read an existing password reset token.

Parameters
applicationId The unique identifier of the application.
passwordResetTokenId The unique identifier of the password reset token.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Tenant readTenant (String tenantId)

Read a tenant.

Parameters
tenantId The unique identifier of the tenant or current for the currently authenticated tenant.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Applications readTenantApplications (String tenantId, Integer offset, Integer limit)

Read a paginated list of applications that belong to a tenant.

Parameters
tenantId The unique identifier of the tenant (current is not a valid value).
offset The zero-based starting index in the entire collection of the first item to return.
limit The maximum number of collection items to return for a single request.
Returns
Throws
IOException IOException if anything goes wrong with the operation.

public abstract Directories readTenantDirectories (String tenantId, Integer offset, Integer limit)

Read a paginated list of directories that belong to a tenant.

Parameters
tenantId The unique identifier of the tenant (current is not a valid value).
offset The zero-based starting index in the entire collection of the first item to return.
limit The maximum number of collection items to return for a single request.
Returns
Throws
IOException IOException if anything goes wrong with the operation.

public void setApiKeyId (String apiKeyId)

Parameters
apiKeyId

public void setApiKeySecret (String apiKeySecret)

Parameters
apiKeySecret

public abstract Account updateAccount (String accountId, Account account)

Update an account.

Parameters
accountId The unique identifier of the account.
account The Account to update.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract AccountStoreMapping updateAccountStoreMapping (String accountStoreMappingId, AccountStoreMapping accountStoreMapping)

Update an account store mapping.

Parameters
accountStoreMappingId The unique identifier of the account store mapping.
accountStoreMapping An AccountStoreMapping instance that contains the fields to update.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Application updateApplication (String applicationId, Application application)

Update an application.

Parameters
applicationId The unique identifier of the application.
application The Application to update.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Directory updateDirectory (String directoryId, Directory directory)

Update a directory.

Parameters
directoryId The unique identifier of the directory.
directory The Directory to update.
Returns
Throws
IOException if anything goes wrong with the operation.

public abstract Group updateGroup (String groupId, Group group)

Update a group.

Parameters
groupId The unique identifier of the group.
group The Group to update.
Returns
  • the updated Group instance.
Throws
IOException if anything goes wrong with the operation.

public abstract Tenant updateTenant (String tenantId, Tenant tenant)

Update a tenant.

Parameters
tenantId The unique identifier of the tenant (current is not a valid value).
tenant A Tenant instance.
Returns
Throws
IOException if anything goes wrong with the operation.