Package org.craftercms.profile.management.web.controllers

Class ProfileController

java.lang.Object

org.craftercms.profile.management.web.controllers.ProfileController

@Controller
@RequestMapping("/profile")
public class ProfileController
extends Object

MVC Controller for displaying and modifying profiles.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URL_PROFILE
static final String	FINAL_QUERY_FORMAT
static final String	MODEL_MESSAGE
static final String	MSG_PROFILE_CREATED_FORMAT
static final String	MSG_PROFILE_DELETED_FORMAT
static final String	MSG_PROFILE_UPDATED_FORMAT
static final String	PARAM_COUNT
static final String	PARAM_QUERY
static final String	PARAM_SORT_BY
static final String	PARAM_SORT_ORDER
static final String	PARAM_START
static final String	PARAM_TENANT_NAME
static final String	PATH_VAR_ID
static final Pattern	QUERY_PATTERN
static final String	URL_CREATE_PROFILE
static final String	URL_DELETE_PROFILE
static final String	URL_GET_PROFILE
static final String	URL_GET_PROFILE_COUNT
static final String	URL_GET_PROFILE_LIST
static final String	URL_UPDATE_PROFILE
static final String	URL_VIEW_NEW_PROFILE
static final String	URL_VIEW_PROFILE
static final String	URL_VIEW_PROFILE_LIST
static final String	VIEW_NEW_PROFILE
static final String	VIEW_PROFILE
static final String	VIEW_PROFILE_LIST

Constructor Summary

Constructors

Constructor	Description
ProfileController(String verificationUrl, ProfileService profileService, org.craftercms.commons.security.permissions.PermissionEvaluator<Profile,String> tenantPermissionEvaluator, org.craftercms.commons.security.permissions.PermissionEvaluator<Profile,Profile> profilePermissionEvaluator)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	createProfile(Profile profile)
Map<String,String>	deleteProfile(String id)
Profile	getProfile(String id)
long	getProfileCount(String tenantName, String query)
List<Profile>	getProfileList(String tenantName, String query, String sortBy, SortOrder sortOrder, Integer start, Integer limit)
Map<String,String>	updateProfile(Profile profile)
String	viewNewProfile()
String	viewProfile()
String	viewProfileList()

Methods inherited from class java.lang.Object

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

Field Details

BASE_URL_PROFILE

public static final String BASE_URL_PROFILE

See Also:

• Constant Field Values

PATH_VAR_ID

public static final String PATH_VAR_ID

See Also:

• Constant Field Values

URL_VIEW_PROFILE_LIST

public static final String URL_VIEW_PROFILE_LIST

See Also:

• Constant Field Values

URL_VIEW_NEW_PROFILE

public static final String URL_VIEW_NEW_PROFILE

See Also:

• Constant Field Values

URL_VIEW_PROFILE

public static final String URL_VIEW_PROFILE

See Also:

• Constant Field Values

URL_GET_PROFILE_COUNT

public static final String URL_GET_PROFILE_COUNT

See Also:

• Constant Field Values

URL_GET_PROFILE_LIST

public static final String URL_GET_PROFILE_LIST

See Also:

• Constant Field Values

URL_GET_PROFILE

public static final String URL_GET_PROFILE

See Also:

• Constant Field Values

URL_CREATE_PROFILE

public static final String URL_CREATE_PROFILE

See Also:

• Constant Field Values

URL_UPDATE_PROFILE

public static final String URL_UPDATE_PROFILE

See Also:

• Constant Field Values

URL_DELETE_PROFILE

public static final String URL_DELETE_PROFILE

See Also:

• Constant Field Values

PARAM_TENANT_NAME

public static final String PARAM_TENANT_NAME

See Also:

• Constant Field Values

PARAM_QUERY

public static final String PARAM_QUERY

See Also:

• Constant Field Values

PARAM_SORT_BY

public static final String PARAM_SORT_BY

See Also:

• Constant Field Values

PARAM_SORT_ORDER

public static final String PARAM_SORT_ORDER

See Also:

• Constant Field Values

PARAM_START

public static final String PARAM_START

See Also:

• Constant Field Values

PARAM_COUNT

public static final String PARAM_COUNT

See Also:

• Constant Field Values

VIEW_PROFILE_LIST

public static final String VIEW_PROFILE_LIST

See Also:

• Constant Field Values

VIEW_NEW_PROFILE

public static final String VIEW_NEW_PROFILE

See Also:

• Constant Field Values

VIEW_PROFILE

public static final String VIEW_PROFILE

See Also:

• Constant Field Values

MODEL_MESSAGE

public static final String MODEL_MESSAGE

See Also:

• Constant Field Values

MSG_PROFILE_CREATED_FORMAT

public static final String MSG_PROFILE_CREATED_FORMAT

See Also:

• Constant Field Values

MSG_PROFILE_UPDATED_FORMAT

public static final String MSG_PROFILE_UPDATED_FORMAT

See Also:

• Constant Field Values

MSG_PROFILE_DELETED_FORMAT

public static final String MSG_PROFILE_DELETED_FORMAT

See Also:

• Constant Field Values

QUERY_PATTERN

public static final Pattern QUERY_PATTERN

FINAL_QUERY_FORMAT

public static final String FINAL_QUERY_FORMAT

See Also:

• Constant Field Values

Constructor Details

ProfileController

public ProfileController(String verificationUrl,
 ProfileService profileService,
 org.craftercms.commons.security.permissions.PermissionEvaluator<Profile,String> tenantPermissionEvaluator,
 org.craftercms.commons.security.permissions.PermissionEvaluator<Profile,Profile> profilePermissionEvaluator)

Method Details

viewProfileList

@RequestMapping(value="/list/view",
                method=GET)
public String viewProfileList()

viewNewProfile

@RequestMapping(value="/new/view",
                method=GET)
public String viewNewProfile()

viewProfile

@RequestMapping(value="/view",
                method=GET)
public String viewProfile()

getProfileCount

@RequestMapping(value="/count",
                method=GET)
@ResponseBody
public long getProfileCount(@RequestParam(value="tenantName",required=false)
 String tenantName,
 @RequestParam(value="query",required=false)
 String query)
                     throws ProfileException

Throws:

ProfileException

getProfileList

@RequestMapping(value="/list",
                method=GET)
@ResponseBody
public List<Profile> getProfileList(@RequestParam(value="tenantName",required=false)
 String tenantName,
 @RequestParam(value="query",required=false)
 String query,
 @RequestParam(value="sortBy",required=false)
 String sortBy,
 @RequestParam(value="sortOrder",required=false)
 SortOrder sortOrder,
 @RequestParam(value="start",required=false)
 Integer start,
 @RequestParam(value="count",required=false)
 Integer limit)
                             throws ProfileException

Throws:

ProfileException

getProfile

@RequestMapping(value="/{id}",
                method=GET)
@ResponseBody
public Profile getProfile(@PathVariable("id")
 String id)
                   throws ProfileException

Throws:

ProfileException

createProfile

@RequestMapping(value="/create",
                method=POST)
@ResponseBody
public Map<String,String> createProfile(@RequestBody
 Profile profile)
                                 throws ProfileException

Throws:

ProfileException

updateProfile

@RequestMapping(value="/update",
                method=POST)
@ResponseBody
public Map<String,String> updateProfile(@RequestBody
 Profile profile)
                                 throws ProfileException

Throws:

ProfileException

deleteProfile

@RequestMapping(value="/{id}/delete",
                method=POST)
@ResponseBody
public Map<String,String> deleteProfile(@PathVariable("id")
 String id)
                                 throws ProfileException

Throws:

ProfileException