jp.co.hitachi.soft.portal.portlet.PortletURI

機能

ポートレット URL変換,ポータルURL変換,およびドキュメントベースURL変換をします。

URL変換種別,変換対象および変換内容を次の表に示します。

表14-4 URLの変換種別,変換対象および変換内容

URL変換種別変換対象変換内容
ポートレットURL変換
  • 相対パス形式
    例:index.jsp
統合アダプタを経由してポータル画面内に遷移するように,URL変換をします。必要に応じてHttpServletResponse#encodeURLを呼び出して,URLRewritingをします。
ドキュメントベースURL変換
  • 相対パス形式
    例:index.jsp
指定されたURLをWebサーバから直接参照するようにURL変換をします。なお,URLRewritingはしません。
ポータルURL変換
  • 相対パス形式
    例:index.jsp
ポータルを経由してコンテンツを取得するようにURL変換をします。統合アダプタは経由しません。
無変換
  • 絶対URL形式
    例:http://server/portal/sample/index.jsp
  • ホスト内絶対パス形式
    例:/portlets/sample/index.jsp
URL変換をしません。
注意
本クラスを使用して取得したURLをポートレットユーティリティタグライブラリのURL指定属性に指定すると,一度変換されたURLに対して再度URL変換が行われるため,変換後のURLが不正となる場合があります。

コンストラクタの説明

PortletURI
形式

public PortletURI(ServletRequest req,
                ServletResponse res)

機能
PortletURIオブジェクトを生成します。
パラメタ
req - 日立APIポートレットに渡されたServletRequestオブジェクト
res - 日立APIポートレットに渡されたServletResponseオブジェクト

メソッドの一覧

戻り値のデータ型メソッド説明
static StringgetRestoreURI(ServletRequest req, ServletResponse res)ポートレット編集状態から復元するURLを取得するstaticメソッドです。
StringgetRestoreURI()ポートレット編集状態から復元するURLを取得します。
static StringlookupURI(ServletRequest req, ServletResponse res, String portletname, PortletInfoBean.Mode mode, String parameter)ポートレットを呼び出すURLを取得するstaticメソッドです。
StringlookupURI(String portletname, PortletInfoBean.Mode mode, String parameter)ポートレットを呼び出すURLを取得します。
static StringtransInlineURI(ServletRequest req,ServletResponse res,String org_uri)ドキュメントベースURL変換をするstaticメソッドです。
StringtransInlineURI(String org_uri)ドキュメントベースURL変換をします。
static StringtransInlineURIEx(ServletRequest req,ServletResponse res,String org_uri)ドキュメントベースURL変換をするstaticメソッドです。
StringtransInlineURIEx(String org_uri)ドキュメントベースURL変換をします。
static StringtransPortalURI(ServletRequest req,ServletResponse res, String org_uri)ポータルURL変換をするstaticメソッドです。
StringtransPortalURI(String org_uri)ポータルURL変換をします。
static StringtransPortletURI(ServletRequest req, ServletResponse res, String org_uri)ポートレットURL変換をするstaticメソッドです。
StringtransPortletURI(String org_uri)ポートレットURL変換をします。
static StringtransContextURI(ServletRequest req, ServletResponse res, String org_uri)ポータルサーバのコンテキストルートからのコンテンツを取得するURLに変換をするstaticメソッドです。
StringtransContextURI(String org_uri)ポータルサーバのコンテキストルートからのコンテンツを取得するURLに変換をします。

メソッドの説明

getRestoreURI〔staticメソッド〕
形式

public static String getRestoreURI(ServletRequest req,
                                  ServletResponse res)

機能
ポートレット編集状態から復元するURLを取得します。
  • 通常画面から呼び出された編集画面で呼び出したとき
    通常画面に遷移するURLを取得します。
  • 最大化画面から呼び出された編集画面で呼び出したとき
    最大化画面に遷移するURLを取得します。
  • 通常画面(最小化表示時)から呼び出された編集画面で呼び出したとき
    最大化画面に遷移するURLを取得します。
  • 編集画面以外から呼び出したとき
    通常画面に遷移するURLを取得します。
パラメタ
req -日立APIポートレットに渡されたServletRequestオブジェクト
res -日立APIポートレットに渡されたServletResponseオブジェクト
戻り値
生成されたURL(最大2,048文字)
例外
PortletException - 次の場合に発生します。
  • 引数req,resの値が不正な場合
注意事項
  • このメソッドを使用した場合,表示するJSPファイルを指定できません。そのため,マッピング定義ファイルで指定したJSPファイル(メイン画面)に編集内容を反映する処理を入れる必要があります。
  • このメソッドは,IFRAMEモード,およびNEWWINDOWモードには対応していません。そのため,これらの画面モードではこのメソッドを呼び出さないようにしてください。
getRestoreURI
形式

public String getRestoreURI()

機能
ポートレット編集状態から復元するURLを取得します。
  • 通常画面から呼び出された編集画面で呼び出したとき
    通常画面に遷移するURLを取得します。
  • 最大化画面から呼び出された編集画面で呼び出したとき
    最大化画面に遷移するURLを取得します。
  • 通常画面(最小化表示時)から呼び出された編集画面で呼び出したとき
    最大化画面に遷移するURLを取得します。
  • 編集画面以外から呼び出したとき
    通常画面に遷移するURLを取得します。
パラメタ
なし
戻り値
生成されたURL(最大2,048文字)
例外
PortletException - 次の場合に発生します。
  • コンストラクタで渡された引数req,resの値が不正な場合
注意事項
  • このメソッドは,PortletURIクラスのコンストラクタで初期化したあとに使用してください。
  • このメソッドを使用した場合,表示するJSPファイルを指定できません。そのため,マッピング定義ファイルで指定したJSPファイル(メイン画面)に編集内容を反映する処理を入れる必要があります。
  • このメソッドは,IFRAMEモード,およびNEWWINDOWモードには対応していません。そのため,これらの画面モードではこのメソッドを呼び出さないようにしてください。
lookupURI〔staticメソッド〕
形式

public static String lookupURI(ServletRequest req,
                              ServletResponse res,
                              String portletname,
                              PortletInfoBean.Mode mode,
                              String parameter)

機能
ポートレットを呼び出すURLを取得します。PortletURIクラスのインスタンス生成後は,次の形式でも利用できます。

public String lookupURI(String portletname,            
                       PortletInfoBean.Mode mode,                        
                       String parameter)

パラメタ
req - 日立APIポートレットに渡されたServletRequestオブジェクト
res -日立APIポートレットに渡されたServletResponseオブジェクト
portletname - 呼び出すポートレットの名称。指定しない場合はnullを設定します。その場合には自ポートレットとみなします。空文字列を指定した場合は,空のポートレットとしてURLを生成するため,クリック時にはエラーとなります。
mode - 呼び出す画面モード。指定できる画面モードを次に示します。
  • MAXIMIZE
  • IFRAME
  • NEWWINDOW
これ以外を指定すると例外が発生します。指定しない場合はnullを設定します。その場合には呼び出し元の画面モードとなります。ただし,呼び出し元の画面モードがDEFAULTの場合はMAXIMIZEになります。呼び出し元とは,このメソッドの実行時のことです。
parameter - 呼び出すポートレットに渡すパラメタ。クエリ文字列で指定します(URLエンコード済みの文字列を指定)。指定できる最大バイト数は1,024バイトです。"?"の付加は不要です。指定しない場合はnullを設定します。
戻り値
生成されたURL(最大2,046文字)
例外
PortletException - 次の場合に発生します。
  • 引数modeの指定に誤りがある場合
  • 引数req,resの値が不正な場合
注意事項
デプロイされていないportletnameを指定した場合,および無効なparameterを指定してもURLは生成されますが,ユーザがURLをクリックした際にエラー画面を表示します。
lookupURI
形式

public String lookupURI(String portletname,
                       PortletInfoBean.Mode mode,
                       String parameter)

機能
ポートレットを呼び出すURLを取得します。PortletURIクラスのコンストラクタで初期化したあとにこのメソッドを利用してください。処理についてはstatic版と同様です。
パラメタ
portletname - 呼び出すポートレットの名称。指定しない場合はnullを設定します。その場合には自ポートレットとみなします。空文字列を指定した場合は,空ポートレットとしてURLを生成するため,クリック時にはエラーとなります。
mode - 呼び出す画面モード。指定できる画面モードを次に示します。
  • MAXIMIZE
  • IFRAME
  • NEWWINDOW
これ以外を指定すると例外が発生します。指定しない場合はnullを設定します。その場合には呼び出し元の画面モードとなります。ただし,呼び出し元の画面モードがDEFAULTの場合はMAXIMIZEになります。呼び出し元とは,このメソッドの実行時のことです。
parameter - 呼び出すポートレットに渡すパラメタ。クエリ文字列で指定します(URLエンコード済みの文字列を指定)。指定できる最大バイト数は1,024バイトです。"?"の付加は不要です。指定しない場合はnullを設定します。
戻り値
生成されたURL(最大2,046文字)
例外
PortletException - 次の場合に発生します。
  • 引数modeの指定に誤りがある場合
transInlineURI〔staticメソッド〕
形式

public static String transInlineURI(ServletRequest req,
                                  ServletResponse res,
                                  String org_uri)

機能
このメソッドは,画像ファイルを指定するとき,およびポータル外に画面遷移するときに使用するURLを生成します。このメソッドで生成されたURLは,ポータルを経由しません。
3.8.4 ポートレットユティリティクラスライブラリ使用時の画面遷移」に従ってドキュメントベースURL変換をします。
パラメタ
req - 日立APIポートレットに渡されたServletRequestオブジェクト
res - 日立APIポートレットに渡されたServletResponseオブジェクト
org_uri - 変換対象URL
戻り値
変換後URL。このメソッドは,プロパティ「jp.co.hitachi.soft.portal.transurlflag」の設定に関わらず,プロトコルとサーバ名称を含まないURLが返却されます。プロトコルとサーバ名称を含むURLを取得する場合は,transInlineURIExメソッドを使用してください。URL変換規則の詳細については,マニュアル「uCosminexus Portal Framework システム管理者ガイド」を参照してください。
例外
PortletException - reqまたはresが不正な場合
java.net.MalformedURLException - 不正なURLを指定した場合
transInlineURI〔staticではないメソッド〕
形式

public String transInlineURI(String org_uri)

機能
このメソッドは,画像ファイルを指定するとき,およびポータル外に画面遷移するときに使用するURLを生成します。このメソッドで生成されたURLは,ポータルを経由しません。
パラメタ
org_uri - 変換対象URL
戻り値
変換後URL。このメソッドは,プロパティ「jp.co.hitachi.soft.portal.transurlflag」の設定に関わらず,プロトコルとサーバ名称を含まないURLが返却されます。プロトコルとサーバ名称を含むURLを取得する場合は,transInlineURIExメソッドを使用してください。URL変換規則の詳細については,マニュアル「uCosminexus Portal Framework システム管理者ガイド」を参照してください。
例外
PortletException - reqまたはresが不正な場合
java.net.MalformedURLException - 不正なURLを指定した場合
transInlineURIEx〔staticメソッド〕
形式

public static String transInlineURIEx(ServletRequest req,
                                  ServletResponse res,
                                  String org_uri)

機能
このメソッドは,画像ファイルを指定するとき,およびポータル外に画面遷移するときに使用するURLを生成します。このメソッドで生成されたURLは,ポータルを経由しません。
3.8.4 ポートレットユティリティクラスライブラリ使用時の画面遷移」に従ってドキュメントベースURL変換をします。
パラメタ
req - 日立APIポートレットに渡されたServletRequestオブジェクト
res - 日立APIポートレットに渡されたServletResponseオブジェクト
org_uri - 変換対象URL
戻り値
変換後URL
例外
PortletException - reqまたはresが不正な場合
transInlineURIEx〔staticではないメソッド〕
形式

public String transInlineURIEx(String org_uri)

機能
このメソッドは,画像ファイルを指定するとき,およびポータル外に画面遷移するときに使用するURLを生成します。このメソッドで生成されたURLは,ポータルを経由しません。
3.8.4 ポートレットユティリティクラスライブラリ使用時の画面遷移」に従ってドキュメントベースURL変換をします。
パラメタ
org_uri - 変換対象URL
戻り値
変換後URL
例外
PortletException - reqまたはresが不正な場合
transPortalURI〔staticメソッド〕
形式

public static String transPortalURI(ServletRequest req,
                                  ServletResponse res,
                                  String org_uri)

機能
3.8.4 ポートレットユティリティクラスライブラリ使用時の画面遷移」に従ってポータルURL変換をします。
パラメタ
req - 日立APIポートレットに渡されたServletRequestオブジェクト
res - 日立APIポートレットに渡されたServletResponseオブジェクト
org_uri - 変換対象URL
戻り値
変換後URL
例外
PortletException - reqまたはresが不正な場合
transPortalURI〔staticではないメソッド〕
形式

public String transPortalURI(String org_uri)

機能
3.8.4 ポートレットユティリティクラスライブラリ使用時の画面遷移」に従ってポータルURL変換をします。
パラメタ
org_uri - 変換対象URL
戻り値
変換後URL
例外
PortletException - reqまたはresが不正な場合
transPortletURI〔staticメソッド〕
形式

public static String transPortletURI(ServletRequest req,
                                   ServletResponse res,
                                   String org_uri)

機能
3.8.4 ポートレットユティリティクラスライブラリ使用時の画面遷移」に従ってポートレットURL変換をします。
パラメタ
req - 日立APIポートレットに渡されたServletRequestオブジェクト
res - 日立APIポートレットに渡されたServletResponseオブジェクト
org_uri - 変換対象URL
戻り値
変換後URL
例外
PortletException - reqまたはresが不正な場合
java.net.MalformedURLException - 不正なURLを指定した場合
transPortletURI〔staticではないメソッド〕
形式

public String transPortletURI(String org_uri)

機能
3.8.4 ポートレットユティリティクラスライブラリ使用時の画面遷移」に従ってポートレットURL変換をします。
パラメタ
org_uri - 変換対象URL
戻り値
変換後URL
例外
PortletException - reqまたはresが不正な場合
java.net.MalformedURLException - 不正なURLを指定した場合
transContextURI〔staticメソッド〕
形式

public static String transContextURI(ServletRequest req,
                                   ServletResponse res,
                                   String org_uri)

機能
このメソッドは,コンテキストルートからのコンテンツのURLを指定するときに使用するURLを生成します。このメソッドで生成されたURLは,ポータルを経由しません。
パラメタ
req - 日立APIポートレットに渡されたServletRequestオブジェクト
res - 日立APIポートレットに渡されたServletResponseオブジェクト
org_uri - 変換対象URL
戻り値
変換後URL
例外
PortletException - reqまたはorg_uriが不正な場合
transContextURI〔staticではないメソッド〕
形式

public String transContextURI(String org_uri)

機能
このメソッドは,コンテキストルートからのコンテンツのURLを指定するときに使用するURLを生成します。このメソッドで生成されたURLは,ポータルを経由しません。
パラメタ
org_uri - 変換対象URL
戻り値
変換後URL
例外
PortletException - org_uriが不正な場合