Tuesday, April 01, 2008

How to manage user data by a remote access

If you want to manage user data by a remote access on PAL Portal, you can use UserManagerServlet(If you use Jetspeed2, download UserManagerServlet.class).

An usage is simple. Please put the servlet information to web.xml:


  <servlet>
<servlet-name>UserManagerServlet</servlet-name>
<servlet-class>jp.sf.pal.portal.servlet.UserManagerServlet</servlet-class>
</servlet>

<servlet-mapping>
<servlet-name>UserManagerServlet</servlet-name>
<url-pattern>/userManager</url-pattern>
</servlet-mapping>



and then access http://localhost:8080/palportal/userManager?name1=value1&... UserManagerServlert has the following features:


  • Check a user authentication

  • Add a user

  • Update a password

  • Delete a user



An example of an output format is below:


<?xml version="1.0" encoding="UTF-8" ?>
<results>
<status>string</status>
<message>string</message>
<result>
<name>string</name>
<value>string</value>
</result>
</results>



Check a user authentication

Parameters passed on URL:
[Request Parameters]="Value"
action=authenticate
username="User name"
password="Password"

Value of "status":
success -> Success!
authentication-failed -> Authentication failed.
invalid-parameter -> Invalid request parameter(s).
excluded-user -> a given user name is excluded.

Add a user

Parameters passed on URL:
[Request Parameters]="Value"
action=create
username="Username"
password="Password"

Value of "status":
success -> Success!
user-already-exists -> User already exists.
server-error -> Server error.
invalid-parameter -> Invalid request parameter(s).
excluded-user -> a given user name is excluded.

Update a password

Parameters passed on URL:
[Request Parameters]="Value"
action=update
username="User name"
password="Password"

Value of "status":
success -> Success!
user-not-found -> User not found.
server-error -> Server error.
invalid-parameter -> Invalid request parameter(s).
excluded-user -> a given user name is excluded.

Delete a user

Parameters passed on URL:
[Request Parameters]="Value"
action=update
username="User name"
password="Password"

Value of "status":
success -> Success!
user-not-found -> User not found.
server-error -> Server error.
invalid-parameter -> Invalid request parameter(s).
excluded-user -> a given user name is excluded.

Labels:

0 Comments:

Post a Comment

<< Home