org.gcube.personalization.userprofileaccess.impl

Class UserProfileAccessService

java.lang.Object

org.gcube.personalization.userprofileaccess.impl.UserProfileAccessService

public class UserProfileAccessService
extends Object

Author:

Panagiota Koltsida, NKUA

Constructor Summary

Constructors

Constructor and Description
UserProfileAccessService() The constructor of the class.

Method Summary

Methods

Modifier and Type	Method and Description
org.gcube.common.core.types.VOID	deleteElement(String elementName) This method deletes an element (or a set of elements) of the user's profile
org.gcube.personalization.userprofileaccess.stubs.GetElementResponse	getElement(String elementName) This method retrieves an element of the user's profile.
String	getElementValue(String elementName) This method retrieves the value of a specific element of the user's profile.
String	getUserProfile(org.gcube.common.core.types.VOID params) This method returns the user profile.
org.gcube.common.core.types.VOID	setElement(org.gcube.personalization.userprofileaccess.stubs.SetElement params) This method creates a new element in the user's profile.
org.gcube.common.core.types.VOID	setElementValue(org.gcube.personalization.userprofileaccess.stubs.SetElementValue params) This method sets a new value to an element of the user's profile.
org.gcube.common.core.types.VOID	updateUserProfile(String profileContent)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserProfileAccessService

public UserProfileAccessService()
                         throws org.gcube.common.core.faults.GCUBEFault

The constructor of the class.

Throws:

org.gcube.common.core.faults.GCUBEFault - Failed to contact the IS client

Method Detail

getUserProfile

public String getUserProfile(org.gcube.common.core.types.VOID params)
                      throws org.gcube.common.core.faults.GCUBEFault

This method returns the user profile.

Parameters:

params - This method has no input parameters

Returns:

A string which contains the user's profile

Throws:

org.gcube.common.core.faults.GCUBEFault - an error occurred

getElementValue

public String getElementValue(String elementName)
                       throws org.gcube.common.core.faults.GCUBEFault

This method retrieves the value of a specific element of the user's profile. If the element does not exist in the profile it returns null.

Parameters:

elementName - It is a XPath expression

Returns:

The value of the element

Throws:

org.gcube.common.core.faults.GCUBEFault - an error occurred

setElementValue

public org.gcube.common.core.types.VOID setElementValue(org.gcube.personalization.userprofileaccess.stubs.SetElementValue params)
                                                 throws org.gcube.common.core.faults.GCUBEFault

This method sets a new value to an element of the user's profile. If the element has already a value, it replaces it.

Parameters:

params: - elementName,is a XPath expression value, the value to be set

Returns:

no Return type

Throws:

org.gcube.common.core.faults.GCUBEFault - an error occurred

getElement

public org.gcube.personalization.userprofileaccess.stubs.GetElementResponse getElement(String elementName)
                                                                                throws org.gcube.common.core.faults.GCUBEFault

This method retrieves an element of the user's profile. If there are many elements with the same name it returns an array which contains all these elements.

Parameters:

elementName - It is a XPath expression

Returns:

the element(s) as an XML node

Throws:

org.gcube.common.core.faults.GCUBEFault - an error occurred

setElement

public org.gcube.common.core.types.VOID setElement(org.gcube.personalization.userprofileaccess.stubs.SetElement params)
                                            throws org.gcube.common.core.faults.GCUBEFault

This method creates a new element in the user's profile. The elementName and the path are XPath expressions.

Parameters:

params: - elementName, the name of the new element value, the value of the new element path, the path under it the new element will be set.

Returns:

no return type

Throws:

org.gcube.common.core.faults.GCUBEFault - an error occurred

deleteElement

public org.gcube.common.core.types.VOID deleteElement(String elementName)
                                               throws org.gcube.common.core.faults.GCUBEFault

This method deletes an element (or a set of elements) of the user's profile

Parameters:

elementName - The element to delete. It is a XPath expression

Returns:

no Return type

Throws:

org.gcube.common.core.faults.GCUBEFault - an error occurred

updateUserProfile

public org.gcube.common.core.types.VOID updateUserProfile(String profileContent)
                                                   throws org.gcube.common.core.faults.GCUBEFault

Throws:

org.gcube.common.core.faults.GCUBEFault