Generare URL în WebSphere Portal
Generarea URL-urilor de Portal corect este unul din cele mai importante taskuri în programarea unei aplicaţii bazate pe WebSphere Portal Express. Există mai multe unelte de programare şi tehnici disponibile pentru generarea URL-urilor WebSphere Portal Express într-un cod personalizat. Următoarea secţiune introduce uneltele de programare disponibile şi discută când este mai adecvată utilizarea fiecăreia dintre unelte.
Tipuri de URL-uri de Portal
- URL-uri de randare
- Acest tip de URL este folosit pentru extragerea unei vederi generale a unei pagini de Portal. Acest lucru nu include specific nicio acţiune de portlet şi nu determină nicio modificare de stare pe parte de server. Un URL de randare corespunde unei operaţii HTTP GET şi este idempotent, adică poate fi rulat de mai multe ori fără a nicio stricăciune. Navigarea normală pe pagina WebSphere Portal Express este făcută din URL-uri de randare.
- URL-uri de acţiune
- URL-urile de acţiune sunt folosite pentru activităţi din portleturi. URL-urile corespund cu HTTP POST sau PUT şi sunt adesea non-idempotente, ceea ce înseamnă că trebuie să fie rulate cel mult o dată. Un URL de acţiune ţinteşte tipic un anumit portlet şi poate cauza modificări de stare pe parte de server. Acţiunea de portlet şi portletul căruia îi este destinată acţiunea sunt duse ca parametri în documentul Stare de navigare.
- URL-uri prietenoase
- URL-ului prietenoase au şiruri ce pot fi citite în URL-ul care descrie calea către o pagină de Portal. Aceste şiruri ce pot fi citite corespund cu Numele URL prietenoase care sunt asociate cu pagini sau
etichete.
În plus, ar putea fi de asemenea jetoane Cale conţinut prietenos în URL. Jetoanele Cale conţinut
prietenos sunt şirurile ce pot fi citite care descriu calea zonei de site la biblioteca Gestionare
conţinut Web asociată cu pagina. Notă: Un URL prietenos ar putea include de asemenea un document Stare de navigaţie codat. Dacă nu include, este un URL prietenos stateless. Există un API de programare specific pentru lucrul cu URL-uri prietenoase.
- URL-urile de vanitate
- URL-urile de vanitate sunt similare cu URL-urile prietenoase stateless, prin faptul că pot fi citite şi nu au un document Stare de navigaţie codat. Însă URL-urile de vanitate nu sunt legate de numele de URL-uri prietenoase asociate cu paginile Portal. În schimb, URL-urile de vanitate sunt intenţionate de a fi aliasuri care sunt simple, uşor de ţinut minte, şi uşor de introdus manual dacă este necesar. URL-urile de vanitate sunt similare cu URL-urile mapate care au fost introduse în ediţiile anterioare de WebSphere Portal. Sunt intenţionate doar ca punct de intrare iniţial, şi nu sunt persistente în bara adresei de browser după ce începe interacţiunea cu site-ul Portal. Există un API de programare specific pentru lucrul cu URL-uri de vanitate.
- URL-uri Parte de conţinut
- URL-urile Parte de conţinut (Piece-of-content) sau URL-urile PoC reprezintă un mecanism de legare ulterior care ţinteşte conţinut în locul artefactelor de Portal cum ar fi paginile. Utilizează un punct de intrare URL diferit în WebSphere Portal (de obicei mypoc sau mycontenthandler în loc de myportal). Un API de programare este disponibil pentru lucrul cu URL-uri Piece-of-Content.
Metode pentru generarea URL-urilor portal
Complexitatea unui URL WebSphere Portal Express face dificilă codarea hard, de aceea nu încercaţi să construiţi URL-uri Portal prin concatenarea de şir. Intenţia designului este aceea că majoritatea URL-urilor auto-referite din Portal sunt generate în cod la momentul rulării pentru evitarea legăturilor întrerupte şi pentru evitarea menţinerii manuale a legăturilor într-un site bazat pe Portal.
- Metoda taguri JSP Portal este utilizată în Theme şi Skin JSPs.
- JSR 286 Portlet API şi taguri JSP corespondente. Această metodă de generare URL adresează aproape toate
cerinţele de generare URL într-un portlet standard.
- Sau dacă este necesar atunci când modificaţi un portlet existent, şi actualizarea nu este o posibilitate, este utilizat API-ul JSR 168 Portlet mai vechi.
- IBM® Portlet API nu mai este suportat. Portleturile mai vechi care sunt scrise la acest API trebuie migrate la standardul curent.
- Parametri de randare publici definiţi de WebSphere Portal. Această metodă poate suporta mai multe cazuri de utilizare care au necesitat anterior utilizarea API-ului stare de navigare.
- Metoda API URL prietenos este specifică pentru cazurile de utilizare care implică URL-uri prietenoase, inclusiv URL-uri care trebuie să fie stateless (nu au document Stare de navigare codat).
- Metoda PoC URL API este specifică pentru crearea URL-urilor Piece-of-Content.
- Metoda API URL-uri de vanitate este specifică pentru lucrul cu URL-uri de vanitate.
- Metoda Navigational State API este cea mai adecvată şi unealta de programare generală pentru generarea de URL-uri, dar necesită cea mai profundă înţelegere şi competenţe de programare.
Atunci când creaţi portleturi de cooperare care necesită comunicaţie inter-portlet, mesageria inter-portlet ar putea fi transportată în URL-urile care sunt generate. Parametrii de randare aşa cum sunt suportaţi de JSR 286 sunt o cale de a realiza acest lucru, dar unelte de progamare suplimentare sunt de asemenea furnizate. Tehnicile JSR 286 pentru portleturile cooperative, precum şi uneltele suplimentare sunt descrise în detaliu în secţiunea Comunicaţie Portlet. Un exemplu de astfel de unealtă este Cooperative Portlet API pentru interoperabilitate între portleturile JSR 286 şi JSR 168.
Task (De la cel mai simplu la cel mai complex) | Metodă de generare URL |
---|---|
Crearea legăturilor de navigare pagină între paginile Portal la nivelul temei. De exemplu, navigare pagini cu file standard. |
Aceste URL-uri sunt de obicei URL-uri de randare simple. În JSP-uri, utilizaţi tagurile JSP <portal-navigation/>. Pentru informaţii suplimentare despre programarea unei teme Portal, vedeţi secţiunea Dezvoltarea temelor şi skin-urilor. |
Un portlet JSR 286, auto-conţinut (nu este necesară comunicaţia inter-portlet), care generează URL-uri de acţiune către el însuşi şi setează proprii parametrii de randare. |
|
Un portlet JSR 286, care necesită comunicaţie inter-portlet cu un alt portlet JSR 286, dar nu navigare pagină (Vizualizarea Portal rămâne pe pagina curentă). |
Ar putea fi suficientă utilizarea suportului parametrului de randare JSR 286. Totuşi, există de asemenea alte tehnici. Pentru informaţii suplimentare, vedeţi secţiunea Comunicaţie Portlet. |
Un portlet JSR 286, care trebuie să interopereze cu un portlet JSR 168. |
Un portlet JSR168 care a funcţionat cu alte portleturi prin comunicaţia inter-portlet este scris pentru utilizarea API Portlet Cooperativ, de asemenea cunoscut ca broker de Proprietate. Broker-ul de proprietate a fost o extensie IBM la specificaţia JSR 168. JSR286 a introdus modelul de eveniment portlet, care a înlocuit Broker-ul de proprietate. Portleturile JSR286 şi portleturile JSR 168 pot interopera dacă sunt îndeplinite anumite condiţii. Pentru informaţii suplimentare, vedeţi secţiunea Interoperabilitatea dintre evenimentele de portlet JSR 286 şi portleturile cooperative JSR 168. |
Un portlet JSR 286, care trebuie să
|
Începând cu Portal 8.5 CF05 utilizaţi parametrii de randare publică definiţi de portal WebSphere Portal
pentru toate aceste cazuri de utilizare şi altele. Aceşti parametrii de randare fac disponibile diverse aspecte
ale contextului cererii curente, în timp ce publicul normal randează parametrii într-un spaţiu de nume WebSphere Portal
specificat.
Note:
Spaţiul de nume al parametrului de randare public specificat WebSphere Portal Express
este http://www.ibm.com/xmlns/prod/websphere/portal/publicparams
(disponibil ca şi NAMESPACE_URI). Următoarele articole sunt parametrii de randare publici speciali pe care WebSphere Portal Express îi suportă:
Există de asemenea un API de comoditate Generare URL Portal. Acest API de comoditate suportă numai URL-uri de randare. Nu pot fi generate modificări de stare (URL-uri de acţiune) utilizând acest API. Următoarele articole
sunt clasele de cheie din acest API:
Există un set echivalent de taguri JSP pentru API-ul de convenienţă Generare URL.
Pentru informaţii suplimentare, vedeţi Taguri JSP pentru portleturile standard. Un exemplu de creare a unui URL de
randare prin utilizarea tagului Convenience API este<portlet-ext:portalRenderURL>. |
URL prietenos |
Un URL prietenos cunoscut de asemenea ca şi Nume de URL Prietenos, este un nume randabil de om pentru o pagină de portal. Este
setat ca şi atribut al paginii şi fiecare pagină poate avea cel mult un URL Prietenos.
Note:
Pentru a utiliza Friendly URL API, trebuie să obţineţi o instanţă FriendlyURLFactory. În funcţie de tipul de cod pe care îl scrieţi, puteţi obţine o instanţă FriendlyURLFactory într-unul din două moduri:
După ce aveţi un FriendlyURLFactory, puteţi apela una dintre metodele newURL() pentru a obţine o instanţă FriendlyURL. O instanţă FriendlyURL poate fi setată prin utilizarea metodelor set*, care sunt scrise în răspuns prin utilizarea metodei writer(Writer). Writer este obţinut de la răspuns şi apoi este dispus prin apelarea dispose(). |
URL vanitate |
Un URL vanitate este un URL simplu, uşor de reţinut pe care un utilizator îl poate introduce manual. URL-urile vanitate sunt gestionate de webmaster cu uneltele administrative WebSphere Portal Express, cum ar fi bara de unelte, portleturile administrative, sau scriptarea XMLAcces. Totuşi, uneori atunci când randaţi un răspuns, este necesar să produceţi o legătură URL vanitate. Următoarea secţiune descrie modul în care să utilizaţi Vanity URL API pentru a obţine un VanityURLNode, care poate fi utilizat pentru randarea unei legături Vanity URL. În funcţie de tipul pachetului de cod pe care îl dezvoltaţi, utilizaţi una dintre cele 3 variante diferite pentru accesarea şi utilizarea
API-ului URL vanitate.
Notă: Aveţi grijă să selectaţi pachetul SPI corect pentru codul care este
dezvoltat.
Documentaţia de interfaţă necesară este în WebSphere Portal Express SPI javadoc.
|
Creaţi actualizaţi sau ştergeţi URL-uri de vanitate. |
Dacă scrieţi cod, intenţionat să creeze, actualizeze, sau să şteargă URL-urile vanitate, mai degrabă decât să
le citească şi să le randeze, utilizaţi următoarele API-uri:
|
Un portlet JSR 286, care necesită generarea unui URL acţiune la un al doilea portlet specific, sau orice alt caz de utilizare care nu este listat aici. |
API stare de navigare |
URL Parte de conţinut |
O parte componentă sau POC URL este un URL care ţinteşte o ursă de date sau un ResolutionService din cadrul de lucru Rezolvator. Dată fiind o astfel de Sursă de date sau ResolutionService, PoC URL API asistă programatorul pentru a crea un URL care duce la pornirea cadrului de lucru Rezolvator pentru corectarea Sursei de date sau a ResolutionService. Pentru a lucra cu Piece-of-Content URL-uri, obţineţi o instanţă a
com.ibm.portal.resolver.acessors.url.PocURLFactory. Similar cu alte URL API-uri,
codul pentru obţinerea unei instanţe a URLFactory depinde dacă scrieţi un portlet
un cod de temă sau dacă rulaţi deja un cod într-un cadru de lucru rezolvator.
După ce obţineţi un PocURLFactory:
|