ユーザー情報のバッチ処理

ユーザー情報のバッチ更新サーブレットを導入することで、ウェブ経由のアクセスでユーザー情報の更新を行うことができます。 アクセスするだけで情報を更新できるので、シェルスクリプトや別なプログラムからアクセスすることで一括の更新等を実現できます。

利用方法

webapps/palportal/WEB-INF/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>
...

必要に応じて、セキュリティの設定をする必要があります。

アクセス方法

http://localhost:8080/palportal/userManager?name1=value1&... にアクセスすると対象の操作が実行されます。 以下の操作を実行できます。

  • ユーザーの認証確認
  • ユーザーの追加
  • パスワードの更新
  • ユーザーの削除
  • ユーザー属性の更新
  • ユーザー属性の削除

出力結果

以下の XML 形式で結果が出力されます。

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

各処理の説明

ユーザーの認証確認

指定されたユーザーが認証できるかを確認します。

URLで渡すパラメータ

リクエストパラメータ
actionauthenticate
usernameユーザー名
passwordパスワード

出力結果のstatus

説明
success正常終了(ユーザーが存在して、パスワードも正しい場合)
authentication-failedユーザー認証に失敗した
invalid-parameterリクエストパラメータが正しくない
excluded-user操作の対象外ユーザーへの処理を行った

ユーザーの追加

指定したユーザー名でユーザーを作成します。

URLで渡すパラメータ

リクエストパラメータ
actioncreate
usernameユーザー名
passwordパスワード

出力結果のstatus

説明
success正常終了(ユーザーが正常に作成された場合)
user-already-existsユーザーが既に存在していて、作成できない
server-errorユーザー作成時にサーバー側でエラーが発生した
invalid-parameterリクエストパラメータが正しくない
excluded-user操作の対象外ユーザーへの処理を行った

パスワードの更新

指定されたユーザーのパスワードを変更します。

URLで渡すパラメータ

リクエストパラメータ
actionupdate
usernameユーザー名
passwordパスワード

出力結果のstatus

説明
success正常終了(ユーザー情報が正常に更新された場合)
user-not-found対象ユーザーが存在しない
server-errorユーザー更新時にサーバー側でエラーが発生した
invalid-parameterリクエストパラメータが正しくない
excluded-user操作の対象外ユーザーへの処理を行った

ユーザーの削除

指定されたユーザー名のユーザーを削除します。

URLで渡すパラメータ

リクエストパラメータ
actionupdate
usernameユーザー名
passwordパスワード

出力結果のstatus

説明
success正常終了(ユーザーが正常に削除された場合)
user-not-found対象ユーザーが存在しない
server-errorユーザー削除時にサーバー側でエラーが発生した
invalid-parameterリクエストパラメータが正しくない
excluded-user操作の対象外ユーザーへの処理を行った

ユーザー属性の取得

指定されたユーザーのユーザー属性を取得します。

URLで渡すパラメータ

リクエストパラメータ
actionget-user-attribute
usernameユーザー名
keyキー

出力結果のstatus

説明
success正常終了(ユーザー属性が正常に取得された場合)
user-not-found対象ユーザーが存在しない
server-errorユーザー削除時にサーバー側でエラーが発生した
invalid-parameterリクエストパラメータが正しくない
excluded-user操作の対象外ユーザーへの処理を行った
value-is-nullキーに対応する値が null の場合

出力結果のresult

key と value 値が出力されます。

ユーザー属性の更新

指定されたユーザー名のユーザー属性を更新します。

URLで渡すパラメータ

リクエストパラメータ
actionupdate-user-attribute
usernameユーザー名
keyキー
value

出力結果のstatus

説明
success正常終了(ユーザー属性が正常に登録または更新された場合)
user-not-found対象ユーザーが存在しない
server-errorユーザー削除時にサーバー側でエラーが発生した
invalid-parameterリクエストパラメータが正しくない
excluded-user操作の対象外ユーザーへの処理を行った

ユーザー属性の削除

指定されたユーザー名のユーザー属性を削除します。

URLで渡すパラメータ

リクエストパラメータ
actionget-user-attribute
usernameユーザー名
keyキー

出力結果のstatus

説明
success正常終了(ユーザー属性が正常に削除された場合)
user-not-found対象ユーザーが存在しない
server-errorユーザー削除時にサーバー側でエラーが発生した
invalid-parameterリクエストパラメータが正しくない
excluded-user操作の対象外ユーザーへの処理を行った
value-is-nullキーに対応する値が null の場合