com.atlassian.jira.crowd.embedded
Interface JaacsService

All Known Implementing Classes:
DefaultJaacsService

public interface JaacsService

Service to support configuration of JIRA as a Crowd Service.


Method Summary
 boolean addRemoteAddress(JiraServiceContext jiraServiceContext, String remoteAddress, long applicationId)
          Adding a new remote address.
 void create(com.atlassian.crowd.embedded.api.User remoteUser, com.atlassian.crowd.model.application.Application application)
          Creates a new Application
 boolean deleteApplication(JiraServiceContext jiraServiceContext, long applicationId)
          Delete a remote address.
 List<com.atlassian.crowd.model.application.Application> findAll(com.atlassian.crowd.embedded.api.User remoteUser)
          Returns a list containing all non-permanent Crowd applications.
 com.atlassian.crowd.model.application.ApplicationImpl findById(com.atlassian.crowd.embedded.api.User remoteUser, Long applicationId)
          Returns the Application having the given id.
 Set<com.atlassian.crowd.model.application.RemoteAddress> getRemoteAddresses(JiraServiceContext jiraServiceContext, long applicationId)
          Retrieve a list of configured remote addresses.
 boolean resetPassword(JiraServiceContext jiraServiceContext, String password, long applicationId)
          Reset a password.
 void update(com.atlassian.crowd.embedded.api.User remoteUser, com.atlassian.crowd.model.application.Application updatedApplication)
          Updates an Application.
 boolean validateAddRemoteAddress(JiraServiceContext jiraServiceContext, String remoteAddress, long applicationId)
          Validate adding a new remote address.
 boolean validateDeleteApplication(JiraServiceContext jiraServiceContext, long applicationId)
          Validate deleting a remote address.
 boolean validateResetPassword(JiraServiceContext jiraServiceContext, String password, long applicationId)
          Validate resetting a password.
 

Method Detail

getRemoteAddresses

Set<com.atlassian.crowd.model.application.RemoteAddress> getRemoteAddresses(JiraServiceContext jiraServiceContext,
                                                                            long applicationId)
Retrieve a list of configured remote addresses.

Parameters:
jiraServiceContext - The service context.
applicationId - Application Id
Returns:
List of configured remote addresses.

validateAddRemoteAddress

boolean validateAddRemoteAddress(JiraServiceContext jiraServiceContext,
                                 String remoteAddress,
                                 long applicationId)
Validate adding a new remote address.

Parameters:
remoteAddress - A new address to add
jiraServiceContext - The service context.
applicationId - Application Id
Returns:
true if validation passes

addRemoteAddress

boolean addRemoteAddress(JiraServiceContext jiraServiceContext,
                         String remoteAddress,
                         long applicationId)
Adding a new remote address.

Parameters:
jiraServiceContext - The service context.
remoteAddress - A new address to add
applicationId - Application Id
Returns:
true if validation passes

validateDeleteApplication

boolean validateDeleteApplication(JiraServiceContext jiraServiceContext,
                                  long applicationId)
Validate deleting a remote address.

Parameters:
jiraServiceContext - The service context.
applicationId - Application Id
Returns:
true if validation passes and action succeeds

deleteApplication

boolean deleteApplication(JiraServiceContext jiraServiceContext,
                          long applicationId)
Delete a remote address.

Parameters:
jiraServiceContext - The service context.
applicationId - Application Id
Returns:
true if validation passes

validateResetPassword

boolean validateResetPassword(JiraServiceContext jiraServiceContext,
                              String password,
                              long applicationId)
Validate resetting a password.

Parameters:
password - A password string
jiraServiceContext - The service context.
applicationId - Application Id
Returns:
true if validation passes

resetPassword

boolean resetPassword(JiraServiceContext jiraServiceContext,
                      String password,
                      long applicationId)
Reset a password.

Parameters:
password - A password string
jiraServiceContext - The service context.
applicationId - Application Id
Returns:
true if validation passes and action succeeds

findAll

List<com.atlassian.crowd.model.application.Application> findAll(com.atlassian.crowd.embedded.api.User remoteUser)
                                                                throws ValidationFailureException
Returns a list containing all non-permanent Crowd applications.

Parameters:
remoteUser - a User representing the user on whose behalf to perform the call
Returns:
a new List
Throws:
ValidationFailureException - if there is a problem

findById

com.atlassian.crowd.model.application.ApplicationImpl findById(com.atlassian.crowd.embedded.api.User remoteUser,
                                                               Long applicationId)
                                                               throws ValidationFailureException
Returns the Application having the given id.

Parameters:
remoteUser - a User representing the user on whose behalf to perform the call
applicationId - a Long containing an application id, or null if it doesn't exist
Returns:
an Application
Throws:
ValidationFailureException - if there is a problem

create

void create(com.atlassian.crowd.embedded.api.User remoteUser,
            com.atlassian.crowd.model.application.Application application)
            throws ValidationFailureException
Creates a new Application

Parameters:
remoteUser - a User representing the user on whose behalf to perform the call
application - an Application to create
Throws:
ValidationFailureException - if there is a problem

update

void update(com.atlassian.crowd.embedded.api.User remoteUser,
            com.atlassian.crowd.model.application.Application updatedApplication)
            throws ValidationFailureException
Updates an Application. The application having the given id will be updated with the remaining contents.

Parameters:
remoteUser - a User representing the user on whose behalf to perform the call
updatedApplication - an Application to update
Throws:
ValidationFailureException - if there is a problem


Copyright © 2002-2012 Atlassian. All Rights Reserved.