服务热线:13616026886

技术文档 欢迎使用技术文档,我们为你提供从新手到专业开发者的所有资源,你也可以通过它日益精进

位置:首页 > 技术文档 > JAVA > 新手入门 > 基础入门 > 查看文档

[portal参考手册]portlet核心api

portlet

        portlet 类是一个portlet 的代码表示,它从portletadapter 继承而来。

 

portlet instance  (portlet实例)

    portlet类实例是一个portlet 类的实例,由portletconfig 中提供的一系列参数参数化的结果,每一个portlet类实例中都包括一个portletconfig 对象,当管理员发布一个新的portlet 应用程序(war 文件)或服务器重新启动时,都会创建一个新的portlet 类实例,portlet 类实例不是portlet 的具体展现,因此对用户和管理员来说portlet 类实例是不可见的。

 

conrete portlet (具体portlet

    portal管理员利用管理接口部署一个portlet应用(war文件)或安装一个portlet的备份。每个动作会创建一个具体portlet,它是由单一的portletsettings对象参数化的,对每一个portlet可能有多个具体portletportletsettings是是可读/写和持久化的对象,portletsettings包含portlet部署描述符中定义的初始化配置参数。

   具体portlet允许一个portlet实例以不同的参数配置运行,不需要创建格外的portlet实例。在一个单一的portlet的生命周期中,许多具体portlet可以被创建和销毁,没有对象明确的代表具体portlet。同一个具体portlet可以被许多用户共享。

 

conrete portlet instance (具体portlet实例)

当一个用户或管理员将具体portlet置于用户页面上,就创建了一个具体portlet实例,这个实例是由一个单一的portletdata对象参数化的具体portlet,一个具体portlet可能具有多个具体portlet实例,portletdata为一个具体portlet 类实例存储持久化信息;portletdata的范围依赖于具体portlet所在页面的范围:如果一个管理员将一个具体portlet置于组页面中,那么portletdata对象包含为用户组存储的数据;如果一个具体的portlet置于用户的页面中,portletdata对象包含为这个用户存储的数据。

当一个用户访问包含具体portlet的页面,这个具体portlet创建一个基于该用户的具体portlet实例。当一个用户登录到portal时,portal服务器为每个用户的portlet创建一个portletsession。被portletsession参数化的一个具体portlet实例将被看成是一个用户的portlet实例。每一个具体portlet实例可能有多个用户portlet实例。一个用户portlet实例是一个portletsession参数化的具体portlet实例, portletsession保存和单一用户portlet实例的使用相关的临时信息。

 

portletconfig

    portletconfig对象提供初始化时用的信息,包装了javax.servlet.servletconfig,仅仅在configure模式是,才能访问配置数据。

getcontext : portletcontext

返回 portletcontext 对象

getname : string

返回portlet的名称

getgroupname : string

返回group名称

supports(portlet.mode mode) : boolean

假如portlet支持提供的模式,返回真,否则返回假.

supports(portletwindow.state state) : boolean

假如portlet支持提供的窗口状态,返回真,否则返回假.

 

portletcontext

portletcontext定义了运行在其中的portlet的视图。使用portletcontext对象,portlet能记下事件日志,获得portlet程序的资源,以及设置储存其他portletservlets能访问的属性。每个portlet都有一个portletcontext的实例部署在容器中。通过portletcontext接口,就可以访问上下文初始参数,找回和存贮上下文属性,获得静态的资源和包含servlertsjsp的请求分发器

getcontainerinfo : string

返回spirit portlet容器的信息

getportletlog : portletlog

返回一个logger

getminorversion : int

得到spirit的次版本

getmajorversion : int

得到spirit的主版本

getservice(class service) : portletservice

返回一个portlet服务的实例

gettext(string bundle, string key, locale locale) : string

返回一个本地化的文本

include(string path, portletrequest request, portletresponse response)

include一个资源,如jsp文件

 

portletrequest

       portletrequest 包装了javax.servlet.http.httpservletrequest对象。封装了客户端请求的所有信息,参数,请求内容数据,portlet模式,窗口状态等。

getclient : client

返回一个客户端,客户端可能是ie浏览器、pda

getdata : portletdata

返回用户的持久化的数据。

getgroup : portletgroup

返回group

setmode(portlet.mode mode)

设置portlet显示的模式。如portlet.mode.configure, portlet.mode.view

getmode : portlet.mode

返回portlet正在运行的模式,如 portlet.mode.configure, portlet.mode.view

getpreviousmode : portlet.mode

返回portlet前一个模式。portlet.mode.configure, portlet.mode.view 。 不存在的化返回portlet.mode.view

getportletsession : portletsession

返回用户的portlet session

getportletsettings :portletsettings

返回portlet settings

getrole : portletrole

返回用户的角色。如 portletrole.guest, portletrole.user, portletrole.admin, portletrole.super,

getuser : user

返回用户对象。

getwindow : portletwindow

返回portlet window

 

portletresponse

portletresponse 包装了javax.servlet.http.httpservletresponse

createuri : portleturi

返回portlet uri

createuri(portletwindow.state state) : portleturi

返回portlet uri

 

portletsession

portletsession包装了javax.servlet.http.httpsession对象,未增加新的方法。

 

portletsettings

   

 

portletdata

扫描关注微信公众号