ENTERPRISE 8. WebServices Programmierhandbuch

Transkript

1 ENTERPRISE 8 WebServices Programmierhadbuch T H E P O W E R O F C O N T E N T A T W O R K

2 Copyright Gauss Iterprise AG Hamburg, Gauss Iterprise, Ic. Irvie, Califoria. Alle Rechte weltweit vorbehalte. Dieses Dokumet sowie die zugehörige Software sid Eigetum der Gauss Iterprise AG oder ihrer Zulieferer ud durch Gesetze zum Schutze des Urheberrechts ud adere Gesetze geschützt. Sie werde uter eier Lizez vertriebe, durch welche die Nutzug, Reproduktio, Vertrieb ud Dekompilierug eigeschräkt wird. Weder der Erhalt och der Besitz dieses Dokumetes ermächtigt Sie, desse Ihalte gaz oder teilweise auf Papier, elektroisch oder eiem adere Medium zu reproduziere, weiterzugebe oder adere de Zugag darauf zu ermögliche. Kei Teil dieses Dokumetes darf i irgedeier Form ud Weise ohe vorherige schriftliche Zustimmug der Gauss Iterprise AG oder Gauss Iterprise, Ic. reproduziert werde. Obwohl bei der Erstellug der Dokumete sorgfältig vorgegage wurde, köe Fehler icht ausgeschlosse werde. Daher köe Gauss Iterprise AG, Gauss Iterprise, Ic. sowie die Autore keie Haftug für die Richtigkeit oder Vollstädigkeit der i diesem Dokumet ethaltee Iformatioe überehme. Die Autore sid für Hiweise über mögliche Fehler i de Dokumete dakbar. Darüber hiaus hafte Gauss Iterprise AG ud Gauss Iterprise, Ic. ur gemäß dem Lizezvertrag der Software, die mit diesem Dokumet verkauft wurde. DIE DOKUMENTATION WIRD WIE BESEHEN GELIEFERT. SÄMTLICHE AUSDRÜCKLICHEN UND STILLSCHWEIGENDEN BEDINGUNGEN, ZUSICHERUNGEN UND GARANTIEN EINSCHLIESSLICH SÄMTLICHER GARANTIEN DER MARKTGÄNGIGKEIT, DER EIGNUNG FÜR EINEN BESTIMMTEN ZWECK ODER DES NICHTVERSTOSSES GEGEN EIN GESETZ WERDEN ABGELEHNT, SOFERN NICHT EINE DERARTIGE ABLEHNUNG RECHTLICH ALS UNGÜLTIG ANGESEHEN WIRD. Alle Warezeiche oder Hadelsmarke, die i diesem Dokumet erwäht wurde, sid Eigetum der etsprechede Firme. Für i der Software ethaltee frei verfügbare Bibliotheke gelte dere Lizezbediguge (vergleiche die Datei LICENSE i \lib\exteral\javacuprutime.jar auf der Istallatios-CD der VIP CM Suite). Programmversio: 8.1 Dokumeteversio: De-01 Erscheiugsdatum: Jui 2002

3

4 Ihaltsverzeichis Abbildugsverzeichis 6 Tabelleverzeichis 7 Kapitel 1 Eileitug Hiweise zu dieser Dokumetatio Typographische Kovetioe 14 Kapitel 2 Kozepte Web-Services VIP WebServices Kozepte vo VIP CotetMaager 26 Kapitel 3 Eisatz vo VIP WebServices Kofiguratio Die VIP WebServices-Beschreibug Fehlerbehadlug 45 Kapitel 4 Zugriff auf Admiistratiosdate ud Authetifizierug Beutzer, Gruppe ud Rolle Fuktiosbereiche Websites Deploymetsysteme Rulevels Allgemeie Abfrage Authetifizierug 68 4 VIP WebServices Programmierhadbuch

5 Kapitel 5 Objektverwaltug VIP-spezifische Datetype Allgemeie Parameter Workflow-Methode Methode der Objektverwaltug Suche ach VIP-Objekte 132 Kapitel 6 Awedugsbeispiele VisualBasic for Applicatios C# ud ASP.NET 162 Glossar 181 Idex 187 VIP WebServices Programmierhadbuch 5

6 Abbildugsverzeichis Abb. 1 Rolle ud Aktioe ierhalb der Web-Service-Architektur 19 Abb. 2 Protokoll-Stack für Web-Services 21 Abb. 3 Methodeaufruf eies Web-Service-Cliets 23 Abb. 4 Grudlegede Fuktiosweise vo VIP WebServices 25 Abb. 5 Applicatios des PortalMaager-Servers 40 Abb. 6 Die Parameter der Applicatio WebServiceApplicatio 41 Abb. 7 Der Datetyp Filter ud davo abgeleitete spezielle Filtertype 133 Abb. 8 Eibidug der Bibliotheke im VisualBasic Editor 149 Abb. 9 C#-Projekt eirichte 163 Abb. 10 WSDL als Webverweis hizufüge 164 Abb. 11 Beutzerkeug ud Passwort eigebe 165 Abb. 12 Automatisch erzeugte Klasse im Namesraum VipWebServiceCliet 166 Abb. 13 Die Beispielawedug (Liste aller PDF-Dateie) 167 Abb. 14 Maildialog der Beispielawedug VIP WebServices Programmierhadbuch

7 Tabelleverzeichis Tabelle 1 Servertype ud mögliche Datehaltugssichte 33 Tabelle 2 Exceptios ud mögliche Ursache 47 Tabelle 3 Datetype für Beutzer 52 Tabelle 4 Datetype für Gruppe ud Rolle 54 Tabelle 5 Parameter der Methode getgroupprofile 56 Tabelle 6 Parameter der Methode getroleprofile 57 Tabelle 7 Parameter der Methode getuserprofile 58 Tabelle 8 Name der Stadard-Fuktiosbereiche 60 Tabelle 9 Parameter der Methode getdeploymetsystems 64 Tabelle 10 Die Kompoete des Datetyps ObjectId 75 Tabelle 11 Die Kompoete des Datetyps ObjectData 77 Tabelle 12 Die Kompoete des Datetyps ObjectType 83 Tabelle 13 Die eizele Objektstatus 84 Tabelle 14 Die mögliche Übergäge zwische de Objektstatus 85 Tabelle 15 Die Kompoete des Datetyps ObjectState 86 Tabelle 16 Die mögliche Zugriffsrechte für VIP-Objekte 87 Tabelle 17 Die Kompoete des Datetyps Permissio 87 Tabelle 18 Die Kompoete des Datetyps Acl 88 Tabelle 19 Die Kompoete des Datetyps AclEtry 89 Tabelle 20 Die Kompoete des Datetyps MultiImportPart 90 Tabelle 21 Die Kompoete des Datetyps DeploymetWaitIfo 93 Tabelle 22 Die Kompoete des Datetyps Ifo 94 Tabelle 23 Parameter der Methode checki 95 Tabelle 24 Parameter der Methode checkout 96 Tabelle 25 Parameter der Methode directrelease 97 Tabelle 26 Parameter der Methode reject 99 VIP WebServices Programmierhadbuch 7

8 Tabelle 27 Parameter der Methode release 100 Tabelle 28 Parameter der Methode submit 101 Tabelle 29 Parameter der Methode udocheckout 102 Tabelle 30 Parameter der Methode addremark 106 Tabelle 31 Parameter der Methode chage 107 Tabelle 32 Parameter der Methode checkreferecesfordelete 108 Tabelle 33 Parameter der Methode checkreferecesforrelease 109 Tabelle 34 Parameter der Methode checkreferecesforsubmit 110 Tabelle 35 Parameter der Methode copy 111 Tabelle 36 Parameter der Methode create 112 Tabelle 37 Parameter der Methode delete 113 Tabelle 38 Parameter der Methode destroy 114 Tabelle 39 Parameter der Methode geeratepage 116 Tabelle 40 Parameter der Methode get 117 Tabelle 41 Parameter der Methode getcheckoutcotet 118 Tabelle 42 Parameter der Methode getchildre 119 Tabelle 43 Parameter der Methode getcotet 120 Tabelle 44 Parameter der Methode getdeploymetjobs 121 Tabelle 45 Parameter der Methode getexteralliks 122 Tabelle 46 Parameter der Methode getlastlogetries 123 Tabelle 47 Parameter der Methode getparet 124 Tabelle 48 Parameter der Methode getversiolist 125 Tabelle 49 Parameter der Methode move 126 Tabelle 50 Parameter der Methode multiimport 128 Tabelle 51 Parameter der Methode restoreversio 129 Tabelle 52 Parameter der Methode SortParetsFirst 131 Tabelle 53 Attributtype ud Filter VIP WebServices Programmierhadbuch

9 Tabelle 54 Parameter der Methode filter 137 Tabelle 55 Klassemodule 150 Tabelle 56 ASP.NET-Beispiel 169 VIP WebServices Programmierhadbuch 9

10 10 VIP WebServices Programmierhadbuch

11 KAPITEL 1 1Eileitug VIP WebServices ist eie Programmierschittstelle, die de Zugriff auf viele vo VIP CotetMaager agebotee Fuktioe ermöglicht. Mithilfe vo VIP WebServices köe Sie vo eiem beliebige Recher auf eie PortalMaager-Server ud damit auf die vo VIP CotetMaager verwaltete Ihalte zugreife. Der Zugriff erfolgt völlig plattformuabhägig. Der Dateaustausch mit dem VIP-CM-System erfolgt über das XML-basierte Protokoll SOAP. VIP WebServices bietet Ihe folgede Fuktioe: Etwicklug eigestädiger VIP-Cliet-Applikatioe, die auf Ihre idividuelle Aforderuge zugeschitte sid Erstelle dyamischer Ihalte für Ihre Website mit der Möglichkeit, auf die Fuktioalitäte zur Verwaltug der Website-Ihalte zuzugreife. Zur Implemetatio der dyamische Ihalte köe Sie eie beliebige Programmiersprache wähle. Itegratio der Fuktioalitäte zur Verwaltug der Website-Ihalte i Desktop- ud Office-Werkzeuge, bei dee der Fuktiosumfag mit gägige Programmiersprache erweitert werde ka VIP WebServices basiert auf dem VIP Java API ud arbeitet mit de gleiche oder sehr ähliche Methode, um de Zugriff über das Iteret zu ermögliche. VIP WebServices Programmierhadbuch 11

12 Kapitel Hiweise zu dieser Dokumetatio Diese Dokumetatio richtet sich a Betreiber eies VIP-CM-Systems, die de Zugriff auf die Date des VIP-CM-Systems über Web-Services eirichte möchte (Diestabieter), ud Softwareetwickler, die über VIP WebServices auf die Fuktioalitäte des VIP-CM-Systems zugreife möchte (Diestehmer). Um über VIP WebServices auf VIP-Fuktioalitätezugreifezuköe, werde etsprechede Vorketisse zu Arbeitsweise ud Fuktioe vo VIP CotetMaager vorausgesetzt. Die Realisierug eier Cliet- Applikatio zur Nutzug vo VIP-Fuktioe ka i verschiedee Programmiersprache erfolge. Die Programmierschittstelle VIP WebServices ist Bestadteil der VIP CM Suite. Zusätzlich zum vorliegede Programmierhadbuch köe Sie Iformatioe aus folgede Quelle beziehe: VIP CotetMaager-Programmierhadbuch: Dieses Dokumet ethält Iformatioe über Iterfaces, Klasse ud Methode der Java-Programmierschittstelle (VIP Java API), mit der die Fuktioalität vo VIP CotetMaager über extere Programme geutzt werde ka. VIP CotetMaager-Beutzerhadbuch: Dieses Dokumet weist Sie ausführlich i alle Aufgabe der redaktioelle Pflege vo Websites im VIP-CM-Workflow ei. VIP CotetMaager-Admiistratorhadbuch: Dieses Dokumet beschreibt die Kofiguratio ud Admiistratio vo VIP-CM- Systeme ud ethält eie ausführlich Darstellug der techische Kozepte vo VIP CotetMaager. 12 VIP WebServices Programmierhadbuch

13 Eileitug Istallatioshadbuch zur VIP CM Suite: Dieses Dokumet beschreibt die Istallatio des VIP-CM-Systems ud gibt Kofiguratioshiweise für HTTP-Server ud JSP-Egie. Der Ihalt dieses Hadbuchs ist folgedermaße gegliedert: Kapitel 2 Kozepte erläutert die grudlegede Kozepte vo VIP WebServices. Kapitel 3 Eisatz vo VIP WebServices ist vorragig für de Diestabieter bestimmt. Es beschreibt die erforderliche Kofiguratiosmaßahme im VIP-CM-System für de Eisatz vo VIP WebServices. Außerdem behadelt es die VIP WebServices- Beschreibug ud die Melduge i Fehlersituatioe. Kapitel 4 Zugriff auf Admiistratiosdate ud Authetifizierug beschreibt die Methode zum Auslese vo Gruppe, Rolle ud Beutzer des VIP-CM-Systems, zum Auslese vo Systemiformatioe sowie zur Authetifizierug. Kapitel 5 Objektverwaltug beschreibt die VIP-Datetype ud Methode zum Zugriff auf VIP-Objekte. Eiige Programmierbeispiele für VIP WebServices fide Sie im Kapitel 6 Awedugsbeispiele. VIP WebServices Programmierhadbuch 13

14 Kapitel Typographische Kovetioe Programmelemete u.ä. werde im Text folgedermaße hervorgehobe: Elemet Schriftart oder Symbol Beispiele Programmoberfläche wie z.b. Meübefehle, Fester, Dialoge, Feldud Schaltflächebezeichuge Pfade zu Verzeichisse, Name vo Dateie ud Verzeichisse Zitate aus Programmcode oder Kofiguratiosdateie Variable, d.h. Platzhalter für bestimmte Elemete Meü Eitrag Laufwerk:\Verzeichis\ Dateiame Code-Zitate {Variable} Datei Alege D:\VIP8\ <head> <title>{viptitle} </title> </head> {VIP- Istallatiosverzeichis} Wichtige Hiweise ud Waruge stehe i graue Käste. Diese Iformatioe sollte Sie ubedigt lese, um Fehler bei der Nutzug ud Verwaltug vo VIP-CM-Systeme sowie Dateverluste zu vermeide. 14 VIP WebServices Programmierhadbuch

15 Eileitug VIP WebServices Programmierhadbuch 15

17 KAPITEL 2 2Kozepte Dieses Kapitel bietet Ihe eie allgemeie Übersicht über Web-Services. Aschließed wird auf die Programmierschittstelle VIP WebServices sowie auf die Kozepte vo VIP CotetMaager eigegage. 2.1 Web-Services Die folgede Abschitte liefer grudlegede Iformatioe zu Web- Services. Was sid Web-Services? Web-Services sid ei XML-basierter Stadard für Schittstelle. Sie ermögliche eie direkte Kommuikatio zwische verschiedee Applikatioe über das Iteret. Ei Web-Service ka vo eier Perso, aber auch vo eiem adere Web-Service aufgerufe werde, der de agebotee Diest bzw. Fuktio utze möchte. Für de Aufruf des Diestes spielt die zugrude liegede Software-Ifrastruktur keie Rolle. Die Schittstelle sid i eiem eiheitliche Stadard defiiert ud gestaltet. Somit köe Web- Services auf Basis plattformuabhägiger Techologie agebude werde. Für geschäftliche Aweduge bedeutet dies, dass die Frage ach der Itegratiossoftware der so geate Middleware zwische zwei proprietäre Systeme uiversell gelöst werde ka. VIP WebServices Programmierhadbuch 17

18 Kapitel 2 Web-Service-Architektur Die Web-Service-Architektur basiert auf dem Zusammespiel der folgede drei Rolle: dem Abieter eies Web-Service bzw. Diestes eiem Diestverzeichis dem Diestehmer Diese Rolle sid durch bestimmte Aktioe wie Veröffetliche, Erstelle eier Afrage sowie Aufbaue eier Verbidug miteiader verküpft. I eiem typische Web-Service-Szeario verfügt der Abieter des Web- Service über eie bestimmte Diest, de er über das Iteret zugäglich mache möchte. Der Diestabieter defiiert zu diesem Zweck eie formale Beschreibug seies Web-Service. Diese Beschreibug beötigt ei Diestehmer für de Zugriff auf de Web-Service. Die Beschreibug ka der Diestabieter i eiem uiverselle Diestverzeichis veröffetliche, damit sei Web-Service leicht gefude werde ka. We der Diestehmer auf eie Web-Service zugreife möchte, sucht er de Diest bzw. seie Beschreibug i der Regel i dem Diestverzeichis. Die Diestbeschreibug ka er aber auch direkt vom Diestabieter erhalte. Mithilfe dieser Beschreibug baut der Diestehmer eie Verbidug zum Diestabieter bzw. zu desse Web-Service auf ud ka so auf de gewüschte Diest zugreife. Die folgede Abbildug veraschaulicht das Zusammespiel zwische de geate Rolle ud de eizele Aktioe. 18 VIP WebServices Programmierhadbuch

19 Kozepte Diestbeschreibug Diestverzeichis Afrage WSDL, UDDI Veröffetlichug WSDL, UDDI Diest Diestehmer Verbidug SOAP Diestabieter Diestbeschreibug Abb. 1 Rolle ud Aktioe ierhalb der Web-Service-Architektur Stadards für Web-Services Die folgede Stadards bestimme im Wesetliche de Web-Services- Stadard: SOAP (Simple Object Access Protocol) WSDL (Web Services Descriptio Laguage) UDDI (Uiversal Descriptio, Discovery, ad Itegratio) Diese Stadards werde i de folgede Abschitte kurz beschriebe. SOAP SOAP (Simple Object Access Protocol) ist ei Stadard, der de plattformuabhägige Zugriff auf Web-Services ermöglicht bzw. die Dateübertragug zwische dem Diestabieter ud dem Diestehmer defiiert. Das verwedete Austauschformat ist XML. VIP WebServices Programmierhadbuch 19

20 Kapitel 2 WSDL WSDL (Web Services Descriptio Laguage) ist die Beschreibugssprache für Web-Services. Es hadelt sich dabei um eie XML-basierte Stadard. Für die Nutzug eies Web-Service seites eier Applikatio ist eie geaue Sprachregelug bzw. Beschreibug erforderlich. Die Beschreibug muss geaue Iformatioe liefer über das verwedete Protokoll, die Adresse ud Port-Nummer, die mögliche Prozedure ud Fuktioe sowiedieformatefür Eigabe ud Ausgabe. Der Abieter eies Web- Service stellt diese Iformatioe i Form eier WSDL-Datei zur Verfügug. UDDI UDDI (Uiversal Descriptio, Discovery, ad Itegratio) ist ebefalls ei XML-basierter Stadard. Er legt fest, wie Detailiformatioe zu Web- Services ud dere Abieter i eiheitlicher Form i Verzeichisse abgelegt werde köe. Um die viele verschiedee Web-Services lokalisiere zu köe, gibt es UDDI-Verzeichisse, i dee Abieter ihre Dieste registriere ud Diestehmer gezielt ach Web-Services suche köe. So etspricht ei UDDI-Verzeichis eier Art (globaler) Gelber Seite. Die Web- Services sid ach bestimmte Eigeschafte sortiert. Die etsprechede Eiträge refereziere die WSDL-Dateie der zugehörige Web- Services. I eiem UDDI-Verzeichis sid Web-Services meist abhägig vo geschäftliche Aweduge. Demetspreched ethält das Verzeichis eie Kategorisierug vo Brache ud Uterehme. 20 VIP WebServices Programmierhadbuch

21 Kozepte Das Web-Service-Schichtemodell Die folgede Abbildug veraschaulicht die Schichtug der eizele Protokolle. UDDI Veröffetlichug des Diestes WSDL Diestbeschreibug SOAP XML-basierter Dateaustausch HTTP Netzwerk Abb. 2 Protokoll-Stack für Web-Services I der uterste Schicht des Protokoll-Stacks fidet der Datetrasport über das Stadard-Protokoll HTTP statt. Oberhalb dieser Schicht erfolgt der XML-basierte Dateaustausch über de Stadard SOAP. Der Stadard beschreibt de Web-Service. Ierhalb der oberste Schicht wird der UDDI-Stadard zur Veröffetlichug des Diestes i eiem UDDI- Verzeichis verwedet. Diese Schicht ist optioal. UDDI ist für die Fuktioalität vo Web-Services icht zwiged erforderlich. Web-Services-Workflow Die folgede Schritte fasse die Bereitstellug ud Nutzug eies Web- Service iklusive der jeweils verwedete Stadards zusamme. 1. Der Diestabieter erstellt eie Web-Service. 2. Er liefert eie Beschreibug des Web-Service ud verwedet dazu de Stadard WSDL. VIP WebServices Programmierhadbuch 21

22 Kapitel 2 3. Der Diestabieter lässt de Web-Service i eiem UDDI- Verzeichis registriere. Dieser Vorgag ist optioal. 4. Ei aderer Web-Service oder Beutzer ermittelt de registrierte Web-Service über eie Suche i eiem UDDI-Verzeichis, das auch die erforderliche Beschreibug liefert. Alterativ ka die Beschreibug dem Diestehmer auch direkt vom Diestabieter zur Verfügug gestellt werde. Aschließed führt der Diestehmer eie Request a de ermittelte Web-Service durch. 5. Der Web-Service bzw. Beutzer, der de Request durchführt, verwedet eie Applikatio, um eie Verbidug zu dem etsprechede Web-Service aufzubaue. SOAP ist das eigesetzte Stadard-Protokoll für de Zugriff auf de Web-Service. 6. Der eigetliche Dateaustausch erfolgt über das Austauschformat XML bzw. das Protokoll HTTP. Web-Services utze Die WSDL-Datei liefert die Beschreibug eies Web-Service. Zur Iterpretatio dieser Beschreibug stehe Diestehmer verschiedee Werkzeuge (Toolkits) zur Verfügug, die die Beschreibug eilese ud automatisch i ei für ihre Cliet-Awedug utzbares Modul umwadel. Der Diestehmer oder auch Cliet bidet dieses Modul i seie Etwicklugsumgebug ei ud schreibt seie eigee Applikatio i der vo seiem Werkzeug uterstützte Programmiersprache. Das Modul arbeitet wie ei Web-Service-Proxy, der Objekte aimmt ud im Name eier adere Awedug ausführt. Der Web-Service-Cliet ka also mithilfe des Moduls bzw. des Proxys de eigetliche Web-Service aspreche ud desse agebotee Fuktioe bzw. Methode utze. Die etsprechede Objekte werde über das Modul wieder a die Applikatio gegebe. 22 VIP WebServices Programmierhadbuch

23 Kozepte Hiweis: Diestehmer, die mit SOAP vertraut sid, köe die für de Zugriff auf de Web-Service erforderliche HTTP-Requests auch ohe zusätzliches Werkzeug erstelle. Die folgede Abbildug veraschaulicht das Zusammespiel der eizele Kompoete. Web-Service SOAP SOAP Web-Service-Proxy Objekte Applikatio Objekte Web-Service-Cliet Abb. 3 Methodeaufruf eies Web-Service-Cliets VIP WebServices Programmierhadbuch 23

24 Kapitel VIP WebServices VIP WebServices ist eie Programmierschittstelle, die de Zugriff auf Fuktioe bzw. Methode vo VIP CotetMaager ermöglicht. Mithilfe vo VIP WebServices ka vo eiem beliebige Recher über das Iteret auf eie PortalMaager-Server ud damit auf die vo VIP CotetMaager verwaltete Ihalte zugegriffe werde. Die auf diese Weise verfügbare Methode köe i eier beliebige Programmiersprache aufgerufe werde. VIP WebServices bietet Ihe folgede Leistugsmerkmale: Uterstützug aller ierhalb der VIP CM Suite verwedete Datetype leseder ud schreibeder Zugriff auf de Ihalt der VIP-Objekte ud die etsprechede Metadate Uterstützug des Workflow-Kozepts vo VIP CotetMaager Ausführe komplexer Suchafrage Der PortalMaager-Server stellt für jede Website eie WSDL-Datei bereit. Diese ethält alle uterstützte Datetype ud Methode. Pro Website ka es idividuell defiierte Attributmege gebe. Aus diesem Grud muss für jede Website eie WSDL-Datei zur Verfügug stehe. Das für de Nachrichteaustausch verwedete Protokoll SOAP besteht aus folgede Kompoete: SOAP-Evelope: eie Art Umschlag, i dem beschriebe ist, was die Nachricht ethält ud was damit geschehe soll SOAP-Body: ethält die eigetliche Nutzdate weitere Iformatioe zum Trasport ud Code Die folgede Abbildug veraschaulicht das grudsätzliche Prizip vo VIP WebServices. 24 VIP WebServices Programmierhadbuch

25 Kozepte Web-Service-Cliet Der Web-Service-Cliet schickt eie Afrage (SOAP-Request) i eiem SOAP-Evelope a de PortalMaager-Server. Der SOAP-Evelope wird dabei vom VIP WebServices-Servlet zerlegt ud der Ihalt der Nachricht (SOAP-Body) a de VIP WebServices-Hadler weitergeleitet. Nach Bearbeitug der Nachricht durch de PortalMaager-Server wird eie etsprechede Atwort (SOAP-Respose) mit ählichem Aufbau vom Servlet zusammegesetzt ud a de Cliet zurückgeschickt. Das Modul des Cliets empfägt die Atwort, tret die SOAP-Bestadteile ud stellt die Nutzdate als Rückgabewerte der aufgerufee Fuktio zur Verfügug. WSDL- Datei SOAP-Request ud SOAP-Respose HTTP-Server VIP WebServices- Servlet PortalMaager-Server Abb. 4 Grudlegede Fuktiosweise vo VIP WebServices VIP WebServices Programmierhadbuch 25

26 Kapitel 2 Hiweis: Der Zugriff auf de PortalMaager-Server über das VIP WebServices-Servlet erfordert eie Authetifizierug (Basic Autheticatio) des jeweilige Beutzers. Dieser Beutzer muss im VIP-CM-System agelegt sei. 2.3 Kozepte vo VIP CotetMaager Der folgede Abschitt beschreibt i kurzer Form die grudlegede Kozepte vo VIP CotetMaager. Dabei steht die Beschreibug der Begriffe im Vordergrud, die beim Arbeite mit VIP WebServices eie Rolle spiele. Eie ausführliche Beschreibug der techische Kozepte sowie der Architektur vo VIP CotetMaager fide Sie im VIP CotetMaager- Admiistratorhadbuch. Weitere Iformatioe zum Arbeite mit eiem VIP-CM-System sid im VIP CotetMaager-Beutzerhadbuch ethalte. Objektdate VIP CotetMaager diet der Verwaltug vo Websites. Websites ethalte bestimmte Dokumete, die für die verschiedeste Zielgruppe verwaltet werde. Solche Dokumete köe z.b. HTML- oder XML- Dokumete, Grafike oder Microsoft-Word-Dokumete sei. Die Dokumete eier vo VIP CotetMaager verwaltete Website werde als VIP-Objekte bezeichet. Jedes VIP-Objekt gehört zu eiem bestimmte Typ (siehe Abschitt Objekttyp auf Seite 29) ud setzt sich aus folgede Bestadteile, de so geate Objektdate, zusamme: 26 VIP WebServices Programmierhadbuch

27 Kozepte Ihalt: Der Ihalt (Cotet) eies VIP-Objekts sid die Date des eigetliche Dokumets wie z.b. die Zeichefolge i eier HTML- Datei oder die Folge vo Bytes eier Grafikdatei. Metadate: Die Metadate eies Objekts liefer Iformatioe über das Dokumet, z.b. vo wem das Dokumet erstellt wurde, zu welchem Zeitpukt es erstellt wurde, welche Titel es hat, vo welchem Typ es ist usw. Protokoll: Das Protokoll liefert eie Beschreibug sämtlicher Äderuge, die am Objekt durchgeführt wurde. Sämtliche VIP-Objekte werde über ihre OID (Object Idetifier) refereziert. Die OID idetifiziert das aktuelle Objekt. Nebe eiem defiierte Satz vo Metadate köe Sie jedem Objekttyp eie Attributmege zuorde. Dies ist eie Mege vo Attribute, die spezielle Eigeschafte vo Objekttype beschreibe. Dazu köe u.a. die Auflösug vo Grafike oder ei Copyright-Vermerk gehöre. Außerdem köe Sie die Ihalte vo VIP-Objekte kategorisiere. Zu diesem Zweck defiiere Sie Objektkategorie, fürdiesieeiereihevo Eigeschafte festlege köe. Eie mögliche Objektkategorie wäre Rechuge, die durch die Eigeschafte Rechugsempfaeger ud Status gekezeichet sei köe. Objektstatus Die Erstellug ud Bearbeitug vo VIP-Objekte mit VIP CotetMaager uterliegt eiem fest defiierte Workflow. Durch die verschiedee Arbeitsschritte befidet sich ei VIP-Objekt immer i eiem bestimmte Bearbeitugszustad. Der Workflow vo VIP CotetMaager bestimmt somit de Status eies VIP-Objekts. Etspreched de Aktioe der Objektverarbeitug werde die folgede Objektstatus uterschiede: VIP WebServices Programmierhadbuch 27

28 Kapitel 2 geädert (auch bei eu agelegte Objekte) ausgeliehe vorgelegt abgeleht freigegebe verzögerte Freigabe gelöscht Durch die verschiedee Arbeitsschritte bzw. Aktioe am VIP-Objekt ädert sich der jeweilige Status eies Objekts. Jede Statusäderug wird protokolliert. Dabei wird die vorherige Versio eies VIP-Objekts immer i eier separate Datehaltug archiviert, sodass ältere Versioe icht verlore gehe. Auf diese Versioe köe Sie jederzeit wieder zugreife. Welche Aktioe Sie a eiem VIP-Objekt durchführe köe, hägt vo folgede Faktore ab: dem aktuelle Status des VIP-Objekts Hiweis: Die Möglichkeit, bestimmte Aktioe am Objekt durchzuführe, hägt auch vom Status des übergeordete Themas ierhalb der Navigatiostopologie ab. der Zugriffssteuerugsliste des VIP-Objekts de zugewiesee Fuktiosbereiche des Beutzers 28 VIP WebServices Programmierhadbuch

29 Kozepte Objekttyp Der Objekttyp bestimmt, zu welcher Klasse vo Dokumete ei VIP- Objekt gehört. Daraus ergebe sich verschiedee Eigeschafte des VIP- Objekts, u.a.: Attribute aus eier Attributmege, die das VIP-Objekt besitze ka Art der Vorlage, die das VIP-Objekt verwede ka Dateie, die bei der Seitegeerierug als Repräsetatio des VIP- Objekts erzeugt werde köe Nebe Objekttype wie z.b. HTML-Seite, JSP-Vorlage oder PDF- Dokumet gibt es Themeobjekte. Ei Themeobjekt ka adere utergeordete Objekte aufehme. Es diet isofer auch der Strukturierug der VIP-Objekte i der Navigatiossicht ud damit der Strukturierug der Website. Ei weiterer wichtiger Objekttyp ist die Vorlage. Sie bestimmt das Layout ud ist für die Seitegeerierug wesetlich. Seitegeerierug Der Ihalt eies VIP-Objekts uterscheidet sich vo de Date, die für eie HTTP-Server geeriert werde. Jedes VIP-Objekt ka eie Vorlage (Template) habe, die i der Regel ei Layout für die zu geerierede Webseite defiiert. Eie Vorlage ist selbst ei VIP-Objekt, das wiederum eie Vorlage ethalte ka. Die geerierte Seite hägt u.a. vo dieser Vorlagehierarchie (Kaskade) ab. Weiterhi spiele der Objekttyp des zu geerierede VIP-Objekts ud die Objekttype der Vorlage eie wesetliche Rolle für die Seitegeerierug. So werde beispielsweise für GIF-Objekte zwei Dateie erzeugt: die Grafik selbst ud eie HTML-Seite mit eiem Verweis auf die Grafikdatei. Bei HTML-Objekte mit zugeordeter Vorlage wird der <body>- Bereich des HTML-Dokumets ausgeschitte. VIP WebServices Programmierhadbuch 29

30 Kapitel 2 Etscheided ist auch die Datehaltugssicht (Edit, QS oder Produktio), die bestimmt, welche VIP-Objekte für die Geerierug verwedet werde. Dabei wird die Datehaltugssicht vom Typ des VIP-CM-Servers bestimmt. Siehe dazu Sichte auf die Datehaltug auf Seite 31. Hiweis: Der Zugriff auf das VIP-CM-System mithilfe vo VIP WebServices erfolgt über de VIP PortalMaager-Server. Die verfügbare Datehaltugssichte auf eiem PortalMaager-Server häge davo ab, vo welchem adere VIP-CM-Server er beachrichtigt wird. Damit alle Datehaltugssichte verfügbar sid, muss der PortalMaager-Server vo eiem Edit-Server beachrichtigt werde. Die Beachrichtigugswege zwische de VIP-CM-Server, das so geate Routig, werde beim Alege eier Website festgelegt Für die Seitegeerierug sid die Deploymetsysteme zustädig.die Deploymetsysteme erzeuge aus de i der Datebak gespeicherte VIP-Objekte die so geate Web-Objekte, die mithilfe eies HTTP- Servers i eiem Browser dargestellt werde köe. Ei Deploymetsystem geeriert die Seite für eie Datehaltugssicht ud eie Website. I eiem VIP-CM-System köe Sie beliebig viele Deploymetsysteme kofiguriere. Jedes Web-Objekt wird über eie URL refereziert. Da für eiud dasselbe VIP-Objekt vo mehrere Deploymetsysteme verschiedee Web-Objekte erzeugt werde köe, gibt es im Allgemeie mehrere URLs für ei ud dasselbe VIP-Objekt. Topologie Orgaisatio vo VIP-Objekte Die VIP-Objekte eier Website köe aufgrud bestimmter Eigeschafte (Metadate) als hierarchische Struktur mit über- ud utergeordete Objekte dargestellt werde. I eier Website gibt es zwei hierarchische Ordugsmerkmale vo VIP-Objekte: die Themestruktur (Navigatiostopologie) ud die Vorlagestruktur (Vorlagetopologie). 30 VIP WebServices Programmierhadbuch

31 Kozepte Themestruktur (Navigatiostopologie) I der Themestruktur werde Objekte Theme zugewiese. Jedes Thema ist wiederum ei VIP-Objekt, das eiem adere Thema utergeordet ist. Diese Hierarchie ist vergleichbar mit Verzeichisse ud Uterverzeichisse i eiem Dateisystem. Für jede Website gibt es geau ei Thema, welches das Wurzelobjekt des Navigatiosbaums eier Website ist. Ausgehed vom Wurzelobjekt verzweigt der Baum i Theme ud Utertheme. Alle Objekte sid diesem Wurzelobjekt direkt oder idirekt utergeordet. Vorlagestruktur (Vorlagetopologie) I der Vorlagestruktur werde Objekte ach ihre Vorlage geordet. Vorlage sid ebefalls VIP-Objekte. Jede Website ka eie oder mehrere Vorlage ethalte, die ieiader verschachtelt sei köe. Alle Objekte werde ihre jeweilige Vorlage utergeordet. Objekte, die keie Vorlage besitze ud selbst icht vom Objekttyp Vorlage sid, werde i dieser Sicht icht dargestellt. Sichte auf die Datehaltug Die Erstellug ud Bearbeitug vo Objekte mit VIP CotetMaager uterliegt eiem fest defiierte Workflow aus Editiere (Bearbeite), Qualitätssicherug ud Veröffetlichug im Produktiosbetrieb. Etspreched dem Bearbeitugsstatus eies VIP-Objekts gibt es verschiedee Sichte auf das Objekt: Edit-, QS- ud Produktiossicht. Edit-Sicht: Die Edit-Sicht repräsetiert de Arbeitsschritt der Erstellug ud Bearbeitug vo VIP-Objekte. Die Objekte wie beispielsweise HTML-Seite werde vo Redakteure oder Grafiker agelegt ud geädert. Dafür beötige diese Beutzer etsprechede Zugriffsrechte für die Objekte. Nach der Bearbeitug werde die Objekte der Qualitätssicherug vorgelegt. Dadurch werde die Äderuge am Objekt auch i der QS-Sicht sichtbar. VIP WebServices Programmierhadbuch 31

32 Kapitel 2 QS-Sicht: Die QS-Sicht zeigt die VIP-Objekte eischließlich aller Äderuge, die der Qualitätssicherug vorgelegt worde sid. Mitarbeiter der Qualitätssicherug köe die Äderuge ihaltlich ud formal prüfe. Aufgrud dieser Prüfug wird etschiede, ob ei Objekt zur Nachbesserug zurückgeschickt oder freigegebe wird. Für die Freigabe ist das etsprechede Zugriffsrecht ötig. Durch die Freigabe werde die Objekte i die Produktiossicht übertrage. Damit wird die aktuelle Versio i der publizierte Website verfügbar. Produktiossicht: Diese Sicht stellt die freigegebee Seite eier Website bereit. Mithilfe eies HTTP-Servers ka auf die Seite über das Iteret oder Itraet zugegriffe werde. Je ach Objektstatus sid die VIP-Objekte eier Website i verschiedee Sichte verfügbar ud köe bearbeitet werde. Ei eu agelegtes Objekt ist beispielsweise ur i der Edit-Sicht sichtbar, icht aber i der QS- oder Produktiossicht. Durch verschiedee Aktioe im Rahme der Objektverarbeitug ka der Status eies VIP-Objekts i de verschiedee Sichte uterschiedlich sei. Verfügbarkeit der Sichte auf de VIP-CM-Server Die verschiedee Sichte auf die VIP-Objekte werde durch die Deploymetsysteme erzeugt, dabei bestimmt der Typ des Deploymetsystems die Sicht: Ei Edit-Deploymetsystem erzeugt die Edit-Sicht usw. Welche Type vo Deploymetsysteme auf eiem VIP-CM-Server istalliert werde köe, ist wiederum vom Servertyp abhägig (Edit, QS, Produktio, PortalMaager). Auf eiem Edit-Server köe Deploymetsysteme für alle Sichte istalliert werde, sodass auf diesem Servertyp der gesamte VIP-CM-Workflow zur Verfügug steht. Auf eiem QS-Server köe higege ur QS- ud Produktiosdeploymetsysteme istalliert werde. Die folgede Tabelle veraschaulicht die Verfügbarkeit der verschiedee Datehaltugssichte auf de Servertype: 32 VIP WebServices Programmierhadbuch

33 Kozepte Tabelle 1 Servertype ud mögliche Datehaltugssichte Servertyp Edit-Sicht QS-Sicht Produktiossicht Edit QS Produktio PortalMaager Die verfügbare Sichte auf eiem PortalMaager-Server häge davo ab, vo welchem adere VIP-CM-Server er beachrichtigt wird (Routig- Eistellug der Website). Nebe der Eiteilug i verschiedee Servertype werde die Server des VIP-CM-Systems außerdem i Kategorie uterteilt: Die Serverkategorie glieder sich i Master- ud Proxyserver. I jedem VIP-CM-System gibt es eie Master-Admiistratiosserver zur Verwaltug der Kofiguratiosud Systemdate ud eie Master-Edit-Server zur Verwaltug der Website-Date. Physikalische Äderuge a de VIP-Objekte ka ur der Master-Edit-Server durchführe. Zusätzlich dazu köe Sie beliebig viele Proxy-Server eirichte. Die Proxy-Server delegiere etsprechede Aktioe a de Master-Edit-Server. Authetifizierug ud Zugriffsrechte Für das Arbeite mit dem VIP-CM-System muss sich ei Beutzer authetifiziere. Bei der Ameldug ist daher die Agabe eier eideutige Beutzerkeug (User-ID) ud eies Passwortes erforderlich. Die Überprüfug der Agabe überimmt der Master-Admiistratiosserver des VIP-CM-Systems. VIP WebServices Programmierhadbuch 33

34 Kapitel 2 Ierhalb eies VIP-CM-Systems gibt es verschiedee Berechtiguge. Für die Arbeit mit VIP-Objekte sid vor allem die Objekt-Zugriffsrechte ud Fuktiosbereiche wichtig. Zugriffsrechte für VIP-Objekte VIP CotetMaager führt für jedes VIP-Objekt eie Zugriffssteuerugsliste (Access Cotrol List, ACL). I dieser Liste ist festgelegt, über welche Zugriffsrechte die jeweilige Beutzer, Gruppe oder Rolle (die so geate Pricipals) verfüge. Dabei köe Zugriffsrechte explizit als erlaubt bzw. verbote ausgezeichet werde, oder sie werde icht explizit gesetzt. Bei eier Rechteüberprüfug werde im letztere Fall alle zugewiesee Gruppe ud Rolle dahigehed utersucht, ob sie eie explizite Erlaubis oder ei Verbot defiiere (wobei ei Verbot immer Vorrag hat). Die Zugriffssteuerugsliste werde vererbt, d.h., jedes i der Navigatiossicht tiefer ageordete VIP-Objekt erbt i der Regel die Rechte des übergeordete Objekts. Beim Alege eier Website wird ei Pricipal ausgewählt, der iitial volle Zugriff auf alle Objekte der Website hat ( Website-Admiistrator ). Dieser wird i der Zugriffssteuerugsliste des Wurzelobjekts der Website aufgeomme. Alle weitere VIP-Objekte dieser Website erbe, falls icht explizit gesetzt, die Rechte des Wurzelobjekts. Fuktiosbereiche Jedem Pricipal köe Fuktiosbereiche zugewiese werde. Über die Fuktiosbereiche steuer Sie, welche Fuktioe vo VIP CotetMaager dem Beutzer zur Verfügug stehe. Dabei erfülle die Fuktiosbereiche zwei wesetliche Aufgabe: 1. Sie lege fest, welche Type vo Objekte die Beutzer alege dürfe. Die Fuktiosbereiche wie z. B. Alege Basis sid stadardmäßig mit Objekttype verküpft. Nur Beutzer, die über de 34 VIP WebServices Programmierhadbuch

35 Kozepte etsprechede Fuktiosbereich verfüge, köe Objekte dieses Objekttyps alege. 2. Sie bestimme, welche Asichte ud Dialoge dem Beutzer im CMS-Cliet zur Verfügug stehe. Auf diese Weise köe Sie geau festlege, welche Aktioe der Beutzer dort durchführe ka. Admiistratiosrechte für das VIP-CM-System Nebe de Zugriffsrechte für VIP-Objekte gibt es außerdem Admiistratiosrechte für das VIP-CM-System. Pricipals mit Admiistratiosrechte habe Zugriff auf das VIP-Admiistratiosprogramm (kurz: Admi-Cliet) ud köe die Elemete des VIP-CM-Systems wie Server, Websites, Deploymetsysteme sowie Beutzeriformatioe bearbeite. Die Admiistratiosrechte köe abgestuft gewährt werde, sodass ei Beutzer ur Teilbereiche der Admiistratio eisehe oder bearbeite ka. Die Admiistratiosrechte köe ausschließlich über de Admi-Cliet geädert werde. VIP WebServices Programmierhadbuch 35

37 KAPITEL 3 3Eisatz vo VIP WebServices Diese Kapitel beschreibt die erforderliche Maßahme für de Eisatz vo VIP WebServices. Außerdem behadelt es die VIP WebServices- Beschreibug ud die Melduge i Fehlersituatioe. 3.1 Kofiguratio Damit Beutzer über VIP WebServices auf Ihr VIP-CM-System zugreife köe, sid folgede Kofiguratiosmaßahme erforderlich: Eirichte eies Servlet-Mappigs Apassuge i der Kofiguratio vo VIP CotetMaager Hiweise: We Sie zum Eibide des VIP PortalMaager-Servers i eie Applicatio-Server eie Webawedug (WAR-Datei) über de Admi- Cliet erzeuge, da erfolgt die otwedige Kofiguratio automatisch. Falls Sie mit dem MS Iteret Iformatio Server arbeite, schalte Sie aus Performace-Grüde de Cache für die ISAPI-Applikatioe für die Website ei. VIP WebServices Programmierhadbuch 37

38 Kapitel 3 Servlet-Mappig eirichte Richte Sie ei Servlet-Mappig für das VIP WebServices-Servlet (Klasse de.gauss.vip.webservice.trasport.webserviceservlet) i der Kofiguratio des Applicatio-Servers bzw. der JSP-Egie ei. Das Mappig für Applicatio-Server, die die Servlet-Spezifikatio 2.2 erfülle, erfordert folgede Eiträge i der Datei WEB-INF/web.xml im Verzeichis der Webawedug, i der der PortalMaager-Server gestartet wird: <servlet> <servlet-ame>webserviceservlet</servlet-ame> <display-ame>vip WebServices-Servlet</display-ame> <servlet-class> de.gauss.vip.webservice.trasport.webserviceservlet </servlet-class> </servlet>... <servlet-mappig> <servlet-ame>webserviceservlet</servlet-ame> <url-patter>/webservice/*</url-patter> </servlet-mappig> We Sie die JSP-Egie Resi verwede, ehme Sie das Mappig folgedermaße vor: <servlet-mappig url-patter= /WebService/* servlet-ame= de.gauss.vip.webservice.trasport.webserviceservlet /> Außerdem müsse Sie für die JSP-Egie Resi die Datei servercofig.wsdd aus dem Verzeichis {VIP-Istallatiosverz.\ cofig\webservices\ i das Verzeichis /WEB-INF/ der etsprechede Webawedug kopiere. Sämtliche Afrage, die mit /WebService/ begie, werde a das VIP WebServices-Servlet weitergeleitet. 38 VIP WebServices Programmierhadbuch

39 Eisatz vo VIP WebServices Apassuge i der Kofiguratio durchführe Damit Beutzer über VIP WebServices auf de PortalMaager-Server zugreife köe, sid folgede Apassuge i der Kofiguratio erforderlich: Zuorde der Applicatio WebServiceApplicatio Parametereistelluge der Applicatio WebServiceApplicatio Die etsprechede Eiträge für die Kofiguratio ehme Sie über de Admi-Cliet vor. Hiweis: Geaue Iformatioe darüber, wie Sie eiem PortalMaager-Server Applicatios zuorde ud die etsprechede Parameter festlege, fide Sie im VIP PortalMaager- Programmierhadbuch. Die Applicatio WebServiceApplicatio zuorde Für de Eisatz vo VIP WebServices orde Sie die Applicatio WebServiceApplicato dem etsprechede PortalMaager-Server zu. Starte Sie dazu de Admi-Cliet vo VIP CotetMaager. Nehme Sie die Zuordug i der Asicht Kofiguratio über Server {Name des PortalMaager-Servers} Applicatios vor. VIP WebServices Programmierhadbuch 39

40 Kapitel 3 Abb. 5 Applicatios des PortalMaager-Servers Parameter der Applicatio WebServiceApplicatio festlege Damit Beutzer über VIP WebServices auf die Ihalte Ihres VIP-CM- Systems zugreife köe, müsse Sie de Zugriff auf die betreffede Websites explizit erlaube. Dies erreiche Sie über etsprechede Parametereistelluge der Applicatio WebServiceApplicatio. Die Parameter defiiere Sie über Kofiguratio Applicatios WebServiceApplicatio Parameter {Parameterame}. 40 VIP WebServices Programmierhadbuch

41 Eisatz vo VIP WebServices Abb. 6 Die Parameter der Applicatio WebServiceApplicatio Die Applicatio WebServiceApplicatio verfügt stadardmäßig über die Parameter allowedwebsites ud deiedwebsites. allowedwebsites: Gebe Sie eie durch Kommata separierte Liste vo Website-Name a. Auf diese Websites ka über VIP WebServices zugegriffe werde. Durch Eigabe eies Sterches (*) erlaube Sie de Zugriff auf alle VIP-verwaltete Websites. Der Stadardwert ist leer, d.h., es ist kei Zugriff über VIP WebServices möglich. deiedwebsites: Gebe Sie eie durch Komma separierte Liste vo Website-Name a. Auf diese Websites ka über VIP WebServices Programmierhadbuch 41

42 Kapitel 3 VIP WebServices icht zugegriffe werde. Durch Eigabe eies Sterches (*) verbiete Sie de Zugriff auf alle VIP-verwaltete Websites. Ei Verbot hat Vorrag vor eier Erlaubis. Der Stadardwert ist leer. 3.2 Die VIP WebServices-Beschreibug Die Beschreibug vo VIP WebServices wird i Form eier WSDL-Datei geliefert. Dieser Abschitt beschreibt, welche Iformatioe die Datei ethält ud wie Sie auf diese zugreife. Auf die VIP WebServices-Beschreibug zugreife Die WSDL-Datei, die die VIP WebServices-Beschreibug ethält, wird dyamisch erzeugt. Um auf die Datei zuzugreife, gebe Sie folgede URL i Ihre Browser bzw. Ihr verwedetes Werkzeug ei: {Basis-URL des HTTP-Servers}/{Verzeichis der Webawedug}/ WebService/Port/{Website-Name}/{Sicht auf die Website-Date}/ {Name des Deploymetsystems}?WSDL Beispiel: IteretSite_edit?WSDL Erläuterug zu eizele Bestadteile der URL?WSDL: Dieser Parameter i der URL bewirkt die Geerierug der WSDL-Datei, die zum Beutzer bzw. Diestehmer übertrage wird. 42 VIP WebServices Programmierhadbuch

43 Eisatz vo VIP WebServices {Sicht auf die Website-Date}: Der Zugriff auf eie Website über VIP WebServices bezieht sich immer auf eie bestimmte Sicht auf die Website-Date. Folgede Werte köe i diese Platzhalter eigetrage werde: Edit-Sicht: edit QS-Sicht: qa Produktiossicht: prod Die verschiedee Sichte auf die Website-Date werde vo de etsprechede Deploymetsysteme erzeugt. Für die Geerierug der WSDL-Datei sid die Iformatioe zur Sicht auf die Website-Date sowie zum Name des Deploymetsystems icht zwiged erforderlich. Gebe Sie die Sicht auf die Website-Date icht a, werde stadardmäßig die Date zur Edit- Sicht übertrage. {Name des Deploymetsystems}: Gebe Sie de Name des Deploymetsystems a, auf desse Date Sie zugreife möchte. We Sie kei Deploymetsystem agebe, wird dies automatisch bestimmt. Dabei sucht der PortalMaager-Server ach eiem Deploymetsystem, desse Basis-URL der des agebotee Web- Service ähelt. Auf diese Weise soll auch bei fehleder Agabe des Deploymetsystems gewährleistet werde, dass der Web-Service- Cliet URLs übermittelt bekommt, mit dee er auf die geerierte Web-Objekte zugreife ka. Hiweis: Um de Zugriff auf die Web-Objekte geau zu steuer, sollte Sie de exakte Name des Deploymetsystems mit der gewüschte Datesicht explizit i der URL agebe. VIP WebServices Programmierhadbuch 43

44 Kapitel 3 Ihalt der VIP WebServices-Beschreibug Die WSDL-Datei zur Beschreibug vo VIP WebServices ethält folgede Iformatioe: Liste der verfügbare Methode mit de erforderliche Eigagsparameter ud dem Rückgabewert VIP-spezifische Datetype URL, über die der Web-Service-Proxy auf de PortalMaager-Server zugreift Die Fuktios- bzw. Methodeaufrufe erfolge ausschließlich über etferte Prozeduraufrufe. Die Eigagsparameter jedes Aufrufs ethalte die Date, die der PortalMaager-Server für die jeweilige Methodeaufrufe beötigt. Aschließed liefert der Web-Service-Proxy sämtliche Date über de Rückgabewert der aufgerufee Methode a de Cliet zurück. Die VIP WebServices-Beschreibug liefert außerdem sämtliche VIPspezifische Datetype, die i de Eigagsparameter oder im Rückgabewert ethalte sei köe. Die wichtigste Datetype werde im Abschitt 5.1 VIP-spezifische Datetype abseite74äher beschriebe. Mit folgeder URL greift der Web-Service-Proxy auf de PortalMaager- Server zu: {Basis-URL des HTTP-Servers}/{Verzeichis der Webawedug}/ WebService/Port/{Website-Name}/{Sicht auf die Website-Date}/ {Name des Deploymetsystems} 44 VIP WebServices Programmierhadbuch

45 Eisatz vo VIP WebServices 3.3 Fehlerbehadlug Für das Auswerte vo Fehlersituatioe sid folgede Elemete wichtig: SOAP-Fehlermelduge Fehlermelduge (Exceptios) der VIP-CM-Server Aufbau vo SOAP-Fehlermelduge Falls der VIP-CM-Server eie Methodeaufruf icht erfolgreich ausführe ka, wird eie SOAP-Fehlermeldug a de Diestehmer zurückgegebe. Diese SOAP-Fehlermeldug ethält ei Fault-Elemet, das wiederum folgede Elemete ethält: faultcode: Hier steht hiter der allgemeie Bezeichug server der Typ der aufgetretee Fehlersituatio, z.b. AccessDeiedExceptio. Diemögliche Exceptios des PortalMaager-Servers sid i Tabelle 2 Exceptios ud mögliche Ursache auf Seite 47 aufgelistet. faultstrig: Beschreibug der Fehlersituatio ud evetuell der Ursache als Klartext. Diese Meldug ist lokalisiert, d.h., sie wird i der Sprache verfasst, die im Admi-Cliet für de agemeldete Beutzer eigestellt ist. faultactor: Dieses Elemet ethält die Bezeichug Vip-Cotet- Maager-API, um dem Diestehmer zu zeige, dass die Ausahmesituatio bei der Bearbeitug im VIP-CM-Server ud icht beim Verbidugsaufbau, bei der Umwadlug der XML-Beschreibug der Eigabedate oder der Trasformatio der Rückgabewerte i eie SOAP-Nachricht aufgetrete ist. detail: Dieses Elemet ethält eie Folge vo lokalisierte Nachrichte, die i komplexe Fehlersituatioe die Suche ach de Ursache erleichter. VIP WebServices Programmierhadbuch 45

46 Kapitel 3 Es folgt ei Beispiel für eie SOAP-Fehlermeldug, die dadurch etstade ist, dass der agemeldete Beutzer admi icht das Recht besitzt, über release ei VIP-Objekt freizugebe. <?xml versio="1.0" ecodig="utf-8"?> <soap:evelope xmls:soap=" xmls:soapec=" xmls:ts=" xmls:types=" ecodedtypes" xmls:xsi=" xmls:xsd=" <soap:body> <soap:fault> <faultcode>ts:server.accessdeiedexceptio</faultcode> <faultstrig>0474: Der Beutzer 'admi' besitzt icht das Recht 'freigebe'.</faultstrig> <faultactor>vip-cotet-maager-api</faultactor> <detail> <ts:message sequeceno="0">0303: Der Master-Server kote die Afrage icht ausführe.</ts:message> <ts:message sequeceno="1">0635: Das Freigebe vo Objekt '171' ist fehlgeschlage.</ts:message> <ts:message sequeceno="2">0300: Währed der Vorbereitug der Aktio 'freigebe' auf Objekt '171' i der Website 'susi' trat ei Fehler auf.</ts:message> <ts:message sequeceno="3">0474: Der Beutzer 'admi' besitzt icht das Recht 'freigebe'.</ts:message> </detail> </soap:fault> </soap:body> </soap:evelope> 46 VIP WebServices Programmierhadbuch

47 Eisatz vo VIP WebServices Exceptios des VIP PortalMaager-Servers Die Fehlersituatioe auf dem VIP PortalMaager werde durch folgede Exceptios klassifiziert: Tabelle 2 Exceptios ud mögliche Ursache Name der Exceptio AccessDeied Exceptio ActioNotPermitted Exceptio AttributeExceptio DatabaseExceptio FileExceptio IvalidCotextId Exceptio Mögliche Ursache Die aufgerufee Methode erfordert eie Operatio, für die der agemeldete Beutzer keie Berechtigug hat. Die Ausführug eier Methode wird verweigert, da sie zu eier Regelverletzug führe würde. Dies ka z.b. der Fall sei, we ei VIP-Objekt vorgelegt werde soll, desse übergeordetes Thema och icht i der QS-Sicht vorliegt. Eie adere Ursache köte sei, dass die Ausführug der Methode zu Nameskoflikte führe würde. Diese Exceptio tritt auf, we ei ubekates Attribut übergebe wird, ei Attribut geädert werde soll, das der Beutzer icht äder darf, oder für das Attribut ei vo der Website-Kofiguratio abweicheder Datetyp verwedet wird. Beim Zugriff auf das vo VIP CotetMaager geutzte RDBMS trate Probleme auf. Beim lesede oder schreibede Zugriff auf eie Datei trate Probleme auf. VIP WebServices verwaltet für jede agemeldete Diestehmer eie Kotext-Keug. We diese ugültig wird, da wird diese Exceptio gemeldet. Der Diestehmer muss sich ereut mit Beutzerkeug ud Passwort amelde. VIP WebServices Programmierhadbuch 47

48 Kapitel 3 Name der Exceptio IvalidObject Exceptio LiceseExceptio LogiExceptio MailExceptio NetExceptio ObjectIUseExceptio Mögliche Ursache Werde die Attribute eies Vip-Objekts vo zwei Beutzers ahezu gleichzeitig geädert, da ka es passiere, dass der Beutzer, desse Äderug zuletzt bearbeitet wird, seie Trasaktio iter mit eiem veraltete Datesatz begit. Dies führt zu dieser Exceptio. Im Fall vo VIP WebServices ist dies jedoch uwahrscheilich, da die itere Objektdate erst kurz vor der Äderug vo VIP PortalMaager geholt werde. Die Lizeze für dievipcmsuitesid abgelaufe. Der Diestehmer hat sich mit eier ugültige Beutzerkeug oder eiem falsche Passwort am VIP-CM-System agemeldet. Probleme beim Versede vo s im Rahme des VIP-Workflows, z.b. weil ei Mail- Server icht erreicht wurde. Bei der Nutzug vo Netzwerkverbiduge durch de VIP-CM-Server, beim Verbidugsaufbau oder beim Dateaustausch trate Probleme auf. Verbidugsprobleme zwische dem VIP WebServices-Diestehmer ud der Applikatio des Diestabieters sid icht der Grud für diese Exceptio. Das VIP-Objekt, das geädert werde soll, wird gerade vo eiem adere Beutzer des VIP-CM- Systems bearbeitet. 48 VIP WebServices Programmierhadbuch

49 Eisatz vo VIP WebServices Name der Exceptio ObjectNotFoud Exceptio RulevelExceptio UexpectedExceptio VetoExceptio VipApiExceptio Mögliche Ursache Der agemeldete Beutzer hat kei Leserecht für ei Objekt, die beim Zugriff auf ei VIP-Objekt agegebee OID/Versiosummer ist icht gültig oder das etsprechede Objekt kote icht i der Website gefude werde. Der agesprochee VIP-CM-Server oder die Website befide sich i eiem Rulevel, i dem die gewüschte Operatio icht möglich ist. Das Rulevel wird u.a. für Wartugsarbeite am VIP- CM-System geädert. Bei der Ausführug eier Methode trate itere Fehler auf, die keiem der adere Fehlertype zugeordet werde köe. Siehe auch VipApiExceptio. Ei auf dem VIP-CM-Server laufeder Aget hat die Ausführug der aufgerufee Methode durch ei Veto verhidert. Agete köe z.b. die Ausführug bestimmter Workflow-Operatioe a ausgewählte VIP-Objekte i eiem bestimmte Zeitraum verhider. Ka ei Fehler keiem der adere Fehlertype zugeordet werde, tritt diese Exceptio auf. VIP WebServices Programmierhadbuch 49

51 KAPITEL 4 4Zugriff auf Admiistratiosdate ud Authetifizierug Mithilfe vo VIP WebServices köe Sie auf die Date ud Fuktioe des Admiistratiosservers des VIP-CM-Systems zugreife: Ermittlug vo Beutzer-, Gruppe- ud Rolleprofile mit de etsprechede Eistelluge ud Zuorduge (siehe Abschitt 4.1 Beutzer, Gruppe ud Rolle auf Seite 52) Ermittlug vo Fuktiosbereiche vo Pricipals (siehe Abschitt 4.2 Fuktiosbereiche auf Seite 59) Ermittlug vo Iformatioe über Websites (siehe Abschitt 4.3 Websites auf Seite 62) Ermittlug vo Iformatioe über Deploymetsysteme (siehe Abschitt 4.4 Deploymetsysteme auf Seite 63) Auslese des Systemzustads (Rulevel) vo VIP-CM-Server ud Websites (siehe Abschitt 4.5 Rulevels auf Seite 64) Ermittlug aderer Iformatioe des VIP-CM-Systems wie Versio ud Sprache (siehe Abschitt 4.6 Allgemeie Abfrage auf Seite 68) VIP WebServices Programmierhadbuch 51

52 Kapitel 4 Hiweis: Der Zugriff auf die Date des Admiistratiosservers setzt Admiistratiosrechte voraus, z.b. das Recht Zugriff auf Beutzerverwaltug für das Lese vo Beutzer-, Gruppe- ud Rolleprofile sowie Zugriff auf Systemverwaltug für das Lese vo Systemiformatioe. Weitere Iformatioe zu de Admiistratiosrechte fide Sie im VIP CotetMaager-Admiistratorhadbuch. Um die Fuktioe vo VIP CotetMaager über VIP WebServices utze zu köe, ist außerdem die Ameldug am VIP-CM-System erforderlich. Lese Sie dazu Abschitt 4.7 Authetifizierug auf Seite Beutzer, Gruppe ud Rolle Sie köe über VIP WebServices die Eistelluge (Profile) vo Beutzer, Gruppe ud Rolle auslese ud die Stadard-Objektrechte vo Pricipals setze. Datetype für Pricipals Für dieübergabe der Profile vo Pricipals werde die Datetype User, Group ud Role beutzt. Alle diese Datetype basiere auf dem Datetyp Pricipal. Die folgede Tabelle zeigt die Kompoete des Datetyps User. Tabelle 3 Datetype für Beutzer Attribut Datetyp Beschreibug ame Strig Beutzerkeug hasprofile boolea Zeigt a, ob weitere Profiliformatio ethalte ist 52 VIP WebServices Programmierhadbuch

53 Zugriff auf Admiistratiosdate ud Authetifizierug Attribut Datetyp Beschreibug commoname Strig Kompletter Name des Beutzers address Strig -Adresse des Beutzers locale Locale Sprache des Beutzers websites Strig[] Liste der Website-Name, dee der Beutzer zugeordet ist subsitute User Stellvertreter, der das Recht hat, sich uter diesem Beutzer azumelde substituteof User[] Mege vo Beutzer, für die dieser Beutzer der Stellvertreter ist groups Group[] Liste der Gruppe, zu dee der Beutzer gehört roles Role[] Liste der Rolle, zu dee der Beutzer gehört iitially Grated Permissios iitially Deied Permissios Permissio[] Permissio[] Erlaubte Stadard-Objektrechte des Beutzers. Diese Rechte werde als Vorgabe eigetrage, we der Beutzer der Zugriffssteuerugsliste (ACL) eies VIP- Objekts hizugefügt wird. Verbotee Stadard-Objektrechte des Beutzers. Diese Rechte werde als Vorgabe eigetrage, we der Beutzer der Zugriffssteuerugsliste (ACL) eies VIP- Objekts hizugefügt wird. VIP WebServices Programmierhadbuch 53

54 Kapitel 4 Attribut Datetyp Beschreibug trustedlogi boolea Zeigt a, ob für diese Beutzer die vertraute Ameldug erlaubt ist. Diese Eistellug macht es möglich, dass sich ei Beutzer ach eier Ameldug bei VIP CotetMaager für adere Produkte der VIP CM Suite icht och eimal authetifiziere muss (sigle sig-o). vipaccess boolea Zeigt a, ob dem Beutzer der Zugag zum VIP-CM-System gestattet ist. Die Datetype Group ud Role sid idetisch aufgebaut. Ihre Kompoete sid i der folgede Tabelle aufgeführt. Tabelle 4 Datetype für Gruppe ud Rolle Attribut Datetyp Beschreibug ame Strig Eideutiger Name der Gruppe bzw. Rolle hasprofile boolea Zeigt a, ob weitere Profiliformatio ethalte ist address Strig -Adresse der Gruppe bzw. Rolle websites Strig[] Liste der Website-Name, dee die Gruppe bzw. Rolle zugeordet ist 54 VIP WebServices Programmierhadbuch

55 Zugriff auf Admiistratiosdate ud Authetifizierug Attribut Datetyp Beschreibug members User[] Liste der Beutzer, die zu dieser Gruppe bzw. Rolle gehöre iitially Grated Permissios iitially Deied Permissios Permissio[] Permissio[] Erlaubte Stadard-Objektrechte der Gruppe bzw. Rolle. Diese Rechte werde als erlaubt eigetrage, we die Gruppe bzw. Rolle der Zugriffssteuerugsliste (ACL) eies VIP- Objekts hizugefügt wird. Verbotee Stadard-Objektrechte der die Gruppe bzw. Rolle. Diese Rechte werde als verbote eigetrage, we die die Gruppe bzw. Rolle der Zugriffssteuerugsliste (ACL) eies VIP-Objekts hizugefügt wird. Methode zum Auslese vo Profile Das Profil eies Beutzers, eier Gruppe oder eier Rolle wird über die Methode getuserprofiles, getgroupprofiles ud getroleprofiles ermittelt. Diese Methode liefer jeweils ei Array aus dem Datetyp User, Group bzw. Role zurück. Dieses Array ethält geau die Pricipals, die de übergebee Filterbediguge etspreche. Zur Festlegug der Filterbedigug werde Date vom Typ Filter ud de davo abgeleitete Datetype beutzt. Diese Datetype werde im Abschitt 5.5 Suche ach VIP-Objekte ab Seite 132 beschriebe. Für die Suche ach Beutzer, Gruppe oder Rolle gelte die folgede Eischräkuge: Es köe ur EqualFilter, LikeFilter ud StrigCotaisFilter verwedet werde. Für die logische Verküpfug sid AdFilter, OrFilter ud NotFilter zugelasse. VIP WebServices Programmierhadbuch 55

56 Kapitel 4 Es köe Bediguge für die Attribute ame, commoname, address, locale, trustedlogi ud vipaccess agegebe werde. getgroupprofiles Liefert die Date der Gruppe zurück, die auf das spezifizierte Filterkriterium zutreffe. Die Ergebismege ka durch startres ud umres begrezt werde. Parameter Tabelle 5 Parameter der Methode getgroupprofile Parameter Datetyp Beschreibug filter Filter das Suchkriterium oder ull, um ach alle Gruppe zu suche sortlist Sort[] Liste der Attribute, ach dee die Ergebisliste sortiert werde soll (i ach Priorität absteigeder Folge) startres it Zahl, die das erste Elemet des Suchergebisses agibt Mit 0 wird das Suchergebis vo Afag a geliefert. umres it Azahl der zurückzulieferde Suchergebisse begied bei startresult Mit -1 werde alle Ergebisse zurückgeliefert. Rückgabe Group[] groups: Liste vo Gruppe, die auf das agegebee Suchkriterium passe 56 VIP WebServices Programmierhadbuch

57 Zugriff auf Admiistratiosdate ud Authetifizierug getroleprofiles Liefert die Date der Rolle zurück, die auf das spezifizierte Filterkriterium zutreffe. Die Ergebismege ka durch startres ud umres begrezt werde. Parameter Tabelle 6 Parameter der Methode getroleprofile Parameter Datetyp Beschreibug filter Filter das Suchkriterium oder ull, um ach alle Rolle zu suche sortlist Sort[] Liste der Attribute, ach dee die Ergebisliste sortiert werde soll (i ach Priorität absteigeder Folge) startres it Zahl, die das erste Elemet des Suchergebisses agibt Mit 0 wird das Suchergebis vo Afag a geliefert. umres it Azahl der zurückzulieferde Suchergebisse begied bei startresult Mit -1 werde alle Ergebisse zurückgeliefert. Rückgabe Role[] roles: Liste vo Rolle, die auf das agegebee Suchkriterium passe VIP WebServices Programmierhadbuch 57

58 Kapitel 4 getuserprofiles Liefert die Beutzerdate der Beutzer zurück, die auf das spezifizierte Filterkriterium zutreffe. Die Ergebismege ka durch startres ud umres begrezt werde. Parameter Tabelle 7 Parameter der Methode getuserprofile Parameter Datetyp Beschreibug filter Filter das Suchkriterium oder ull, umachalle Beutzer zu suche sortlist Sort[] Liste der Attribute, ach dee die Ergebisliste sortiert werde soll (i ach Priorität absteigeder Folge) startres it Zahl, die das erste Elemet des Suchergebisses agibt Mit 0 wird das Suchergebis vo Afag a geliefert. umres it Azahl der zurückzulieferde Suchergebisse begied bei startresult Mit -1 werde alle Ergebisse zurückgeliefert. Rückgabe User[] users: Liste vo Beutzer, die auf das agegebee Suchkriterium passe 58 VIP WebServices Programmierhadbuch

59 Zugriff auf Admiistratiosdate ud Authetifizierug Stadard-Objektrechte übergebe Die Kompoete iitialgratedpermissios der Datetype User, Group ud Role ethält eie Liste mit erlaubte Stadard-Objektrechte für de Pricipal. Diese voreigestellte Zugriffsrechte sollte vo eiem VIP WebServices-Diestprogramm als Eistellug vorgeschlage werde, we der Pricipal i die Zugriffssteuerugsliste eies VIP- Objekts aufgeomme wird. Die Kompoete IitialDeiedPermissios wird aalog verwedet ud beihaltet die verbotee Stadard-Objektrechte des Pricipals. Die Äderug der Zugriffssteuerugsliste eies VIP-Objekts erfolgt mithilfe des Datetyps Acl, siehe ACL eies VIP-Objekts äder auf Seite Fuktiosbereiche I VIP CotetMaager müsse Beutzer direkt oder idirekt (über die Gruppe- bzw. Rollezugehörigkeit) Fuktiosbereiche zugeordet sei, um bestimmte Aktioe im Rahme der Website-Verwaltug durchzuführe. Allgemeie Iformatioe zu Fuktiosbereiche erhalte Sie im Abschitt Fuktiosbereiche auf Seite 34. I VIP WebServices werde Fuktiosbereiche durch de Datetyp FuctioalArea repräsetiert. Die Methode getfuctioalareas liefert alle ierhalb des VIP-CM-System defiierte Fuktiosbereiche. Der Datetyp FuctioalArea ethält de Name des Fuktiosbereichs ud die Mege vo Beutzer, Gruppe ud Rolle, die diesem Fuktiosbereich direkt zugeordet sid. Die folgede Tabelle zeigt die verfügbare Stadard-Fuktiosbereiche ud die dazugehörige Name. Über de Admi-Cliet köe eigee VIP WebServices Programmierhadbuch 59

60 Kapitel 4 Fuktiosbereiche agelegt ud Objekttype zugeordet werde. Diese Fuktiosbereiche werde durch ihre Name repräsetiert. Tabelle 8 Name der Stadard-Fuktiosbereiche Fuktiosbereich Kostate Abhägige Asicht oder Fuktio im CMS-Cliet Alege Basis Alege Fortgeschritte VIP ADVANCED Alege vo Objekte, die auf de zugeordete Objekttype basiere Alege Dyamisch Alege Formular Alege Persoalisierug Itelligete Vorlage DYNAMIC FORM PERSONALIZATION ITF Wird icht stadardmäßig verwedet, diet der Abwärtskompatibilität zu VIP 5e Direkte Freigabe DIRECT_RELEASE Bearbeite der Optio Direkte Freigabe im CMS-Cliet (Metadate-Dialog) Dialog Refereze REFERENCES Asicht des Refereze- Dialogs im CMS-Cliet Dialog Zugriffsrechte ACCESS_RIGHTS Asicht des Zugriffsrechte- Dialogs im CMS-Cliet Dialog Protokoll LOG Asicht des Protokoll-Dialogs im CMS-Cliet Filter Stadard FILTER_STANDARD Verwede der Stadardfilter im CMS-Cliet 60 VIP WebServices Programmierhadbuch

61 Zugriff auf Admiistratiosdate ud Authetifizierug Fuktiosbereich Kostate Abhägige Asicht oder Fuktio im CMS-Cliet Filter Bearbeite FILTER_EDIT Bearbeite vo Filter im Filtereditor des CMS-Cliets Asicht Utergeordete Objekte OBJECTLIST Asicht der utergeordete Objekte eies VIP-Objekts im CMS-Cliet Asicht Objektliste LISTVIEW Asicht Objektliste im CMS- Cliet Asicht Meie Objekte Asicht Vorlagestruktur FILTER_TODO TEMPLATE_STRUCTURE Asicht Meie Objekte im CMS-Cliet Asicht Vorlagestruktur im CMS-Cliet Volltextsuche COMI_SEARCH Verwede der Volltextsuche im CMS-Cliet Methode zum Auslese vo Fuktiosbereiche getfuctioalareas Liefert alle im VIP-CM-System verfügbare Fuktiosbereiche zurück Parameter keie Rückgabe FuctioalArea[] fuctioalareas: dieverfügbare Fuktiosbereiche VIP WebServices Programmierhadbuch 61

62 Kapitel Websites Eie Website ierhalb eies VIP-CM-Systems wird eideutig durch eie Name idetifiziert. VIP WebServices bietet die Methode getwebsitenames, um die Name aller Websites auszulese, die im VIP- CM-System verwaltet werde. Jeder Website sid im Allgemeie mehrere Deploymetsystem zugeordet. Methode für Websites getattributesets Liefert alle der Website zugeordete Attributmege zurück Parameter keie Rückgabe AttributeSet[] attributesets: dieverfügbare Attributmege getobjectcategories Liefert alle der Website zugeordete Objektkategorie zurück Parameter keie Rückgabe ObjectCategory[] objectcategories: dieverfügbare Objektkategorie 62 VIP WebServices Programmierhadbuch

63 Zugriff auf Admiistratiosdate ud Authetifizierug getobjecttypes Liefert alle der Website zugeordete Objekttype zurück Parameter keie Rückgabe ObjectType[] objecttypes: dieverfügbare Objekttype getwebsitenames Liefert die Name aller im VIP-CM-System verfügbare Websites zurück Parameter keie Rückgabe strig[] websitenames: die Name der verfügbare Websites 4.4 Deploymetsysteme Es gibt drei verschiedee Type vo Deploymetsysteme, etspreched de Datehaltugssichte Edit, QS ud Produktio. Ei Deploymetsystem für das Edit-System verfügt über alle VIP-Objekte ud verwedet diese für die Seitegeerierug. Im Qualitätssicherugs- bzw. Produktiosdeploymetsystem sid ur die etsprechede Date der jeweilige Sicht vorhade. Die wesetliche Eigeschafte eies Deploymetsystems sid wie folgt: die Website, auf der das Deploymetsystem basiert der Server, auf dem das Deploymetsystem ausgeführt wird VIP WebServices Programmierhadbuch 63

64 Kapitel 4 das Verzeichis auf dem o.g. Server, i dem die geerierte Seite gespeichert werde solle die Basis-URL, die für die Geerierug vo Verweise verwedet werde soll Mit der Methode getdeploymetsystems ka die Liste aller Deploymetsysteme für eie Website ermittelt werde. Pro Deploymetsystem werde der Name ud der Typ a de Diestehmer zurückgegebe. getdeploymetsystems Liefert alle Deploymetsysteme für eie agegebee Website zurück Parameter Tabelle 9 Parameter der Methode getdeploymetsystems Parameter Datetyp Beschreibug website strig der Name der Website Rückgabe DeploymetSystem[] deploymetsystems: Liste der verfügbare Deploymetsysteme 4.5 Rulevels Der Rulevel bezeichet de aktuelle Zustad eies VIP-CM-Servers oder eier Website, der defiiert, welche fuktioale Kompoete des Servers oder der Website gerade aktiviert bzw. deaktiviert sid. Die Rulevels sid uterteilt i Server-Rulevels ud Website-Rulevels, wobei die Website-Rulevels auf de Server-Rulevels aufbaue. Weitere 64 VIP WebServices Programmierhadbuch

65 Zugriff auf Admiistratiosdate ud Authetifizierug Agabe zu de Rulevels fide Sie im VIP CotetMaager-Admiistratorhadbuch. Die Rulevels köe mit der Methode listallrulevels() ausgelese werde. Beim Start eies Servers werde die Rulevels vo Rulevel 0 bis Rulevel 10 durchlaufe, beim Heruterfahre des Servers etspreched vo 10 bis 0. Darüberhiaus köe die Rulevels vo Server ud Websites über de Admi-Cliet vo VIP CotetMaager separat gesteuert werde. Mit der Methode getrulevel ka der aktuelle Rulevel der Website, die dem Web-Service zugeordet ist, ermittelt werde (d.h. die Rulevel ab 6). Folgede Rulevels stehe für VIP-CM-Server zur Verfügug: 0 Server gestoppt: Der Server ist herutergefahre. 1 Verbiduge geschlosse: Alle Kommuikatiosverbiduge wurde geschlosse. Datebak- ud LDAP-Verbiduge sowie Dieste sid icht mehr verfügbar. Beim Übergag zum ächsthöhere Rulevel wird die Verbidugsverwaltug aufgebaut. 2 Keie Beutzer agemeldet: Es sid keie Beutzer mehr a diesem VIP-CM-Server agemeldet. Beim Übergag zum ächsthöhere Rulevel wird die Beutzerverwaltug aufgebaut. 3 Keie Agete aktiv: Alle Server-Agete wurde beedet. Beim Übergag zum ächsthöhere Rulevel werde alle Server-Agete gestartet. 4 Eizelutzerbetrieb. BeimÜbergag vo Rulevel 5 auf Rulevel 4 werde alle Beutzer bis auf de Admiistrator, der die Rulevel- Äderug vorimmt, abgemeldet ud köe sich icht mehr am VIP-CM-System amelde. Dieser Rulevel ist besoders für Wartugsarbeite am VIP-CM-System vorgesehe. Beim Übergag zum ächsthöhere Rulevel wird das System für alle Beutzer freigegebe. VIP WebServices Programmierhadbuch 65

66 Kapitel 4 5 Server läuft: Der VIP-CM-Server ist vollstädig hochgefahre. Folgede Rulevels vo Websites gibt es. Für die Website-Rulevel wird zumidestes der Server-Rulevel 4 vorausgesetzt. 6 Website icht zugreifbar: Eie bzw. alle Websites sid icht mehr verfügbar (auch icht für lesede Zugriffe). Damit sid auch die Deploymetsysteme icht mehr aktiv. 7 Website wird kofiguriert: Die Kofiguratiosdate der Website werde geschriebe. Beim Übergag zum ächsthöhere Rulevel werde die Websites für de lesede Zugriff iitialisiert. 8 Website schreibgeschützt: Auf eie bzw. auf alle Websites ka lesed zugegriffe werde. Vom Deploymetsystem abhägige Date wie z.b. URLs ud Pfade sid i diesem Rulevel och icht verfügbar. Beim Übergag zum ächsthöhere Rulevel werde die Deploymetsysteme iitialisiert. 9 Deploymet abgeschlosse: Die Iitialisierug der Deploymetsysteme ist abgeschlosse. Die Deploymetsysteme köe u ausstehede Aufträge ausführe. Neue Aufträge werde etgegegeomme ud die etsprechede Seite bearbeitet. Beim Übergag zum ächsthöhere Rulevel werde die Websites für de schreibede Zugriff freigegebe. Die Verteilug vo VIP-Objekte a Proxy-Server fidet erst im ächste Rulevel statt. 10 Website läuft: Eie bzw. alle Websites stehe für de schreibede Zugriff zur Verfügug. 66 VIP WebServices Programmierhadbuch

67 Zugriff auf Admiistratiosdate ud Authetifizierug Methode zum Auslese vo Rulevels getrulevel Liefert de Rulevel der Website zurück, die dem Web-Service zugeordet ist. Parameter keie Rückgabe Rulevel rulevel: der Rulevel der Website listallrulevels Liefert alle i eiem VIP-CM-System mögliche Rulevel zurück Parameter keie Rückgabe Rulevel[] rulevels: diemögliche Rulevel VIP WebServices Programmierhadbuch 67

68 Kapitel Allgemeie Abfrage Für allgemeie Abfrage stehe folgede Methode zur Verfügug: getlaguages Liefert alle vom VIP-CM-Server uterstützte Sprache zurück Parameter keie Rückgabe Locale[] laguages: Liste der verfügbare Sprache getvipversio Liefert die Versio der VIP CM Suite zurück Parameter keie Rückgabe KerelVersio versio: Versio der VIP CM Suite 4.7 Authetifizierug Der Zugriff auf ei VIP-CM-System über VIP WebServices erfordert eie Beutzerauthetifizierug, um die eizele Methode überhaupt utze zu köe. Bei viele Aktioe werde die Fuktiosbereiche des Beutzers bzw. die Zugriffssteuerugsliste der VIP-Objekte geprüft, um festzustelle, ob der Beutzer über die otwedige Rechte verfügt. Die Authetifizierug erfolgt bei der Ameldug des Web-Service am VIP- CM-Server. Sie führt im VIP-CM-System zur Erzeugug eies bei jeder Ameldug uterschiedliche, ierhalb eies VIP-CM-Systems eideu- 68 VIP WebServices Programmierhadbuch

69 Zugriff auf Admiistratiosdate ud Authetifizierug tige CotextId-Objekts. Damit ist der Web-Service eideutig im System registriert. Die CotextId bleibt im VIP-CM-System so lage erhalte, wie die zum aktuelle Web-Service gehörige Sessio existiert. Es ist für VIP WebServices keie weitere logi-methode erforderlich. Die Übergabe vo Beutzerame ud Passwort für die Ameldug am VIP- CM-System erfolgt über die auf Grudlage vo VIP WebServices programmierte Awedug. Name ud Passwort müsse dazu im Header des HTTP-Requests eigetrage werde. Für das Beede eier Sessio, die Authetifizierug als Stellvertreter ud das Äder vo Passwörter stehe folgede Methode zur Verfügug: chagepassword Ädert das Passwort für de agegebee Beutzer Parameter strig ewpasswd das eue Passwort Rückgabe keie logout Meldet de Beutzer bekat durch seie CotextId ab Parameter keie Rückgabe keie VIP WebServices Programmierhadbuch 69

70 Kapitel 4 substitutelogi Meldet de bereits agemeldete Beutzer bekat durch seie CotextId als Vertreter des agegebee Beutzers username am VIP-CM-System a. Der durch die CotextId repräsetierte Beutzer muss als Vertreter des agegebee Beutzers arbeite dürfe. Parameter strig username Name des Beutzers, i desse Vertretug gearbeitet werde soll Rückgabe keie 70 VIP WebServices Programmierhadbuch

71 Zugriff auf Admiistratiosdate ud Authetifizierug VIP WebServices Programmierhadbuch 71

73 KAPITEL 5 5Objektverwaltug I diesem Kapitel werde zuächst die wichtigste Datetype beschriebe, die für die Bearbeitug vo VIP-Objekte über VIP WebServices geutzt werde. Aschließed werde die Methode der Objektverwaltug vorgestellt. Dabei wird zwische folgede Hauptgruppe uterschiede: allgemeie Parameter wie DeploymetWaitIfo ud Ifo, siehe Abschitt 5.2 Allgemeie Parameter auf Seite 92 Methode für diedurchführug vo Workflow-Aktioe wie Ausleihe oder Vorlege, siehe Abschitt 5.3 Workflow-Methode auf Seite 94 Methode für die Bearbeitug vo VIP-Objekte z.b. zum Äder der Metadate, siehe Abschitt 5.4 Methode der Objektverwaltug auf Seite 103 Hiweis: Da die Sytax des Methodeaufrufs vo der verwedete Programmiersprache abhägt, wurde eie allgemeie Form der Beschreibug vo Methodeame ud Parameter gewählt. Im letzte Abschitt wird die Suche ach VIP-Objekte mithilfe vo Filter beschriebe, siehe Abschitt 5.5 Suche ach VIP-Objekte auf Seite 132. VIP WebServices Programmierhadbuch 73

74 Kapitel VIP-spezifische Datetype Jedes VIP-Objekt wird durch eie Reihe vo Date repräsetiert. Um über VIP WebServices auf das VIP-CM-System zuzugreife, beötige Sie Ketisse über die verwedete Datetype. Ei Datetyp legt dabei die mögliche Werte ud dere Verwedug fest. I VIP CotetMaager werde die Date iter sofer es sich icht um Java-Basistype wie Iteger- oder Boolsche Werte hadelt durch Java- Klasse bzw. Java-Iterface-Defiitioe charakterisiert. I VIP WebServices sid diese Datetype XML-Schema-Datetype zugeordet. Zum Teil köe dabei die Stadard-XML-Schema Simple Types verwedet werde. Für adere VIP-Datetype müsse VIPspezifische Complex Types verwedet werde, die zum Namesraum gehöre. Eie vollstädige Übersicht über die verwedete Datetype bietet die WSDL-Datei vo VIP WebServices, siehe Ihalt der VIP WebServices- Beschreibug auf Seite 44. Im Folgede werde die wichtigste Datetype beschriebe: OID ud Versioe vo VIP-Objekte, siehe Datetyp: ObjectId auf Seite 75 Metadate, siehe Datetyp: ObjectData auf Seite 76 Objekttyp, siehe Datetyp: ObjectType auf Seite 82 Objektstatus, siehe Datetyp: ObjectState auf Seite 84 Objekt-Zugriffsrechte, siehe Datetyp: Permissio auf Seite 86 Zugriffsteuerugsliste, siehe Datetyp: Acl auf Seite 88 Eitrag i der Zugriffssteuerugsliste, siehe Datetyp: AclEtry auf Seite 89 Repräsetatio vo Baumstrukture für Objekte, siehe Datetyp: MultiImportPart auf Seite VIP WebServices Programmierhadbuch

75 Objektverwaltug Datetyp: ObjectId Die Objekt-ID, die so geate OID, repräsetiert eie Referez auf ei VIP-Objekt. Sie ist ei eideutiger Bezeicher für ei VIP-Objekt ierhalb eier Website. Die Eideutigkeit bezieht sich ur auf die aktuelle Versio eies VIP-Objekts. Archivierte Objekte habe dieselbe OID mit eier uterschiedliche Versiosummer. Tabelle 10 Die Kompoete des Datetyps ObjectId Attribut Datetyp Beschreibug id strig Die itere Repräsetatio als Zeichekette We ei VIP-Objekt eie Workflow-Schritt wie Bearbeitug oder Qualitätssicherug durchläuft, etsteht eie eue Versio des Objekts. Die Versioierug vo VIP-Objekte erfolgt mithilfe des Datetyps Versio. Eie Versio besteht aus drei Nummer für Hauptversio (major), Nebeversio (mior) ud Mikroversio (micro). Die Mikroversio ädert sich, we ei VIP-Objekt i der Edit-Sicht geädert wird (Ausleihe, Metadate äder). Die Nebeversio ädert sich, we ei VIP-Objekt zur Qualitätssicherug vorgelegt wird, wobei da die Mikroversio auf 0 gesetzt wird. Die Hauptversio wird beim Freigebe erhöht, wobei die Nebeversio auf 0 gesetzt wird. Mithilfe der Methode getversiolist köe Sie die verfügbare Versioe eies VIP-Objekts bestimme, siehe getversiolist auf Seite 125. VIP WebServices Programmierhadbuch 75

76 Kapitel 5 Datetyp: ObjectData Allgemeie Iformatioe zu Objektdate erhalte Sie im Abschitt Objektdate auf Seite 26. Der Datetyp ObjectData ethält die Metadate eies VIP-Objekts. Bei der Suche mit der filter-methodewirdeiobjectdata-array zurückgegebe, das je ei Elemet pro gefudees VIP-Objekt ethält. Diese Elemete ethalte da geau die Attribute, die i dem Eigabeparameter attributekeys der filter-methode agegebe wurde. Mit der get-methode köe Sie sich diese Date geau für eivip- Objekt eier bestimmte Versio vom Server hole, auch hier müsse Sie die gewüschte Attribute i der Liste attributekeys vorher wähle. Umgekehrt wird bei der chage- ud der create-methode ei Parameter vom Typ ObjectData a de Server übergebe, um die Attribute zu äder bzw. die Attribute eies eue Objekts zu setze. Die Symbole i der folgede Tabelle verdeutliche die mögliche Aktioe für das etsprechede Metadatum: Der Wert ull ist für dieses Attribut erlaubt. Nach dem Attribut ka gesucht werde, d.h., es ka für die Kostruktio vo Filter verwedet werde. Der Attributwert ka geädert werde. 76 VIP WebServices Programmierhadbuch

77 Objektverwaltug Tabelle 11 Die Kompoete des Datetyps ObjectData Attribut Datetyp Beschreibug ACL attributekeys childre compatible ObjectTypes Acl Strig[] ObjectId[] ObjectType[] Die Zugriffssteuerugsliste des VIP- Objekts Werde die Objektdate mit eier create- oder get-methode zum Server gesedet, so muss dieses Array die Mege vo Attributame ethalte, dere Werte vom Server gesetzt oder geädert werde solle. Werde die Objektdate vom Server zurückgeschickt, da ethält dieses Array die Mege der Attributame, die tatsächlich vom Server gesetzt wurde. Alle adere Attribute habe ichtverlässliche Werte. Die OIDs der utergeordete Objekte (Kider) des VIP-Objekts, falls das VIP-Objekt ei Thema ist. Falls das VIP-Objekt kei Thema ist oder es keie utergeordete Objekte hat, ist dieser Wert ull. Die Objekttype, i die der Objekttyp des VIP-Objekts überführt werde ka cotetsize it Die Größe des Ihalts des VIP- Objekts i Bytes -1 bedeutet, dass das Objekt keie Ihalt hat VIP WebServices Programmierhadbuch 77

78 Kapitel 5 Attribut Datetyp Beschreibug createdby createddate deploymethit descriptio directrelease edit Receivers expiredate User datetime strig strig boolea Strig[] datetime Der Beutzer, der das VIP-Objekt agelegt hat Datum ud Uhrzeit der Erzeugug des VIP-Objekts Der Deploymethiweis, d.h. der Vorschlag für de Dateiame des aus dem VIP-Objekt erzeugte Web-Objekts Die Beschreibug des VIP-Objekts Dieser Wert ist geau da wahr, we das VIP-Objekt direkt freigegebe werde ka, also ach eier Äderug icht erst vorgelegt werde muss. Die -Adresse, die zur Beachrichtigug verwedet werde solle, we das VIP-Objekt abgeleht oder das Ablaufdatum erreicht wurde Datum ud Uhrzeit des Ablaufs des VIP-Objekts 78 VIP WebServices Programmierhadbuch

79 Objektverwaltug Attribut Datetyp Beschreibug keywords likedfrom liksto locale modifiedby modifieddate objectcategory Strig[] ObjectId[] Lik[] Locale User datetime strig Eie Mege vo Schlüsselbegriffe, die diesem VIP-Objekt zugeordet sid Ei Array vo OIDs der VIP- Objekte, die Refereze auf das aktuelle VIP-Objekt ethalte. Falls keie Refereze vorhade sid, wird ull zurückgeliefert. Ei Array der Refereze, die sich im Ihalt des VIP-Objekts befide. Falls keie Refereze vorhade sid, wird ei leeres Array zurückgeliefert. Die für das VIP-Objekt verwedete Sprache (Locale) Der Beutzer, der das VIP-Objekt zuletzt geädert hat Datum ud Uhrzeit der letzte Äderug des VIP-Objekts Der Name der Objektkategorie des VIP-Objekts oder ull, we das VIP-Objekt keier Objektkategorie zugeordet ist VIP WebServices Programmierhadbuch 79

80 Kapitel 5 Attribut Datetyp Beschreibug objectid objectstate objecttype pathame pedig ReleaseDate possible Actios ObjectId ObjectState ObjectType strig datetime Strig[] Die OID, die das VIP-Objekt ierhalb eier Website eideutig idetifiziert Der aktuelle Status des VIP-Objekts Der Objekttyp des VIP-Objekts. Dieser ka im Rahme der Regel für kompatible Objekttype geädert werde. Der Pfadame der geerierte Seite des VIP-Objekts. Dieser hägt vom Deploymetsystem ab. We kei Deploymetsystem für diese Website existiert, steht hier ull. Datum ud Uhrzeit, falls das VIP- Objekt verzögert freigegebe werde soll Die mögliche Workflow-Aktioe, die mit dem aktuelle Status des VIP-Objekts ud de Rechte des Beutzers durchgeführt werde köe 80 VIP WebServices Programmierhadbuch

81 Objektverwaltug Attribut Datetyp Beschreibug QA Receivers releasedby releaseddate release Receivers subtitle surrogateurl targetgroup template Strig[] User datetime Strig[] strig strig strig ObjectId Die -Adresse, die zur Beachrichtigug verwedet werde solle, we das VIP-Objekt zur Qualitätssicherug vorgelegt wurde Der Beutzer, der das VIP-Objekt zuletzt freigegebe hat Datum ud Uhrzeit der letzte Freigabe des VIP-Objekts Die -Adresse, die zur Beachrichtigug verwedet werde solle, we das VIP-Objekt freigegebe wurde Die Überschrift des VIP-Objekts Die URL für die Surrogatseite des VIP-Objekts oder ull, falls dieser Objekttyp keie Surrogatseite erfordert Die Zielgruppe des VIP-Objekts Die OID der Vorlage des VIP- Objekts oder ull, falls dem Objekt keie Vorlage zugeordet ist VIP WebServices Programmierhadbuch 81

82 Kapitel 5 Attribut Datetyp Beschreibug Der Datetyp ObjectType repräsetiert de Typ eies VIP-Objekts. Objekttype sid Website-spezifisch ud ur ierhalb eier bestimmte Website gültig. Die Objekttype eier Website köe mit der Methode getobjecttypes ausgelese werde (siehe getobjecttypes auf Seite 63). Mithilfe der Methode chage ka der Objekttyp geädert werde (siehe chage auf Seite 106). Eie Übersicht über kompatible Objekttitle topic URL versio strig ObjectId strig Versio Der Titel (Name) des VIP-Objekts Die OID des Themas, i dem das VIP-Objekt liegt, oder ull, falls das VIP-Objekt der Wurzelkote der Website ist Die URL für die geerierte Seite des VIP-Objekts. Diese URL hägt vom Deploymetsystem ab, dem VIP WebServices zugeordet wurde. Existiert kei Deploymetsystem, wird hier ull geliefert. Die Versio des VIP-Objekts websitename strig Der Name der Website, zu der das VIP-Objekt gehört Datetyp: ObjectType Allgemeie Iformatioe zu Objekttype erhalte Sie im Abschitt Objekttyp auf Seite VIP WebServices Programmierhadbuch

83 Objektverwaltug type ethält das Attribut compatibleobjecttypes des Datetyps ObjectData. Tabelle 12 Die Kompoete des Datetyps ObjectType Attribut Datetyp Beschreibug attributesetname strig Der Name der Attributmege, die diesem Objekttyp zugeordet ist defaultsuffix strig Die Stadard-Edug vo Dateie, die Ihalte vo VIP-Objekte dieses Typs ethalte. Diese Edug wird z. B. bei der Erzeugug euer VIP-Objekte verwedet. descriptio strig Die lokalisierte Beschreibug des Objekttyps fileocreate Needed boolea Dieser Wert ist geau da wahr, we beim Alege eies VIP-Objekts dieses Typs eie Datei agegebe werde muss. frame boolea Dieser Wert ist geau da wahr, we der Objekttyp ei Frame ist. imageurl strig Die URL auf die Datei des Symbols, das de Objekttyp repräsetiert. Dabei ist die URL abhägig vo dem Deploymetsystem, das VIP WebServices zugeordet ist. We kei Deploymetsystem für diese Website existiert, wird hier ull geliefert. mimetype strig Der zum Objekttyp gehörige MIME-Typ ame strig Der Name des Objekttyps VIP WebServices Programmierhadbuch 83

84 Kapitel 5 Attribut Datetyp Beschreibug Die folgede Tabelle zeigt die Status ud die mögliche Übergäge zwische de Status. Der Übergag zu eiem adere Status erfolgt im Rahme vo Workflow-Operatioe. We ei VIP-Objekt eu agelegt wird, erhält es de Status edited. Iformatioe zu de eizele Worktemplate boolea Dieser Wert ist geau da wahr, we der Objekttyp eie Vorlage ist. topic boolea Dieser Wert ist geau da wahr, we der Objekttyp ei Thema ist. Datetyp: ObjectState Allgemeie Iformatioe zum Status vo VIP-Objekte erhalte Sie im Abschitt Objektstatus auf Seite 27. Der Datetyp ObjectState repräsetiert de Status im Lebeszyklus eies VIP-Objekts. Tabelle 13 Die eizele Objektstatus Status checked_out deleted edited rejected released release_at submitted Beschreibug Das VIP-Objekt wurde ausgeliehe. Das VIP-Objekt wurde gelöscht. Das VIP-Objekt wurde geädert (Metadate oder Ihalt). Das VIP-Objekt wurde abgeleht. Das VIP-Objekt wurde freigegebe. Das VIP-Objekt wurde freigegebe, wird jedoch erst später publiziert. Das VIP-Objekt wurde zur Qualitätssicherug vorgelegt. 84 VIP WebServices Programmierhadbuch

85 Objektverwaltug flow-methode erhalte Sie im Abschitt 5.3 Workflow-Methode ab Seite 94. Tabelle 14 Die mögliche Übergäge zwische de Objektstatus Status vor der Operatio Status ach der Operatio Operatio edited edited chage edited checked_out checkout edited deleted delete edited submitted submit checked_out edited checki oder udocheckout deleted Das Objekt ist aschließed icht mehr im VIP- CM-System verfügbar destroy deleted rejected reject submitted rejected reject submitted released release submitted release_at release release_at released Automatisch, we das Freigabedatum erreicht ist release_at checked_out checkout release_at edited chage released checked_out checkout released edited chage VIP WebServices Programmierhadbuch 85

86 Kapitel 5 Tabelle 15 Die Kompoete des Datetyps ObjectState Attribut Datetyp Beschreibug descriptio strig Die lokalisierte Beschreibug des Objektstatus imageurl strig Die URL auf die Datei des Symbols, das de Objektstatus repräsetiert. Dabei ist die URL abhägig vo dem Deploymetsystem, das VIP WebServices zugeordet ist. We kei Deploymetsystem für diese Website existiert, wird hier ull geliefert. ame strig Der Name des Status Datetyp: Permissio Allgemeie Iformatioe zu Zugriffsrechte erhalte Sie im Abschitt Zugriffsrechte für VIP-Objekte auf Seite 34. Der Datetyp Permissio repräsetiert ei Zugriffsrecht, das für VIP- Objekte gewährt oder verweigert werde ka. Jedes VIP-Objekt hat eie Zugriffssteuerugsliste (ACL), die eie Mege vo Pricipals zusamme mit ihre gewährte ud verweigerte Zugriffsrechte ethält. Das VIP- Objekt erbt die ACL des übergeordete Objekts (rekursiv), we es keie eigee ACL hat. Zu Details bezüglich der ACL siehe de Datetyp Acl. 86 VIP WebServices Programmierhadbuch

87 Objektverwaltug Tabelle 16 Die mögliche Zugriffsrechte für VIP-Objekte Name Abkürzug Beschreibug CHANGE_RIGHTS cr Recht zur Äderug der Zugriffsrechte eies VIP-Objekts CREATE c Recht zum Alege euer VIP-Objekte DELETE d Recht zum Lösche vo VIP-Objekte READ r Recht zum Lese eies VIP-Objekts READ_PRODUCTION rp Recht zum Lese eies VIP-Objekts i der Produktiossicht RELEASE rl Recht zur Freigabe eies VIP-Objekts TREE_OPERATIONS t Recht zur Durchführug vo Baumoperatioe (Kopiere, Verschiebe) WRITE w Recht zum Äder eies VIP-Objekts WRITE_META wm Recht zum Äder vo Metadate Tabelle 17 Die Kompoete des Datetyps Permissio Attribut Datetyp Beschreibug ame strig Der Name (als Abkürzug) des Zugriffsrechts VIP WebServices Programmierhadbuch 87

88 Kapitel 5 Datetype für Zugriffssteuerugsliste Für das Bearbeite vo Zugriffssteuerugsliste stehe zwei Datetype zur Verfügug: 1. Acl 2. AclEtry Datetyp: Acl Eie Zugriffssteuerugsliste (Access Cotrol List = ACL) kombiiert eie Mege vo Zugriffsrechte. I eiem VIP-CM-System ethält eie ACL typischerweise alle Zugriffsrechte, die für ei VIP-Objekt gesetzt wurde. I eier ACL sid die Zugriffsrechte für Pricipals (Beutzer, Gruppe, Rolle, Grupperolle oder Jeder ) gesetzt. Ei Zugriffsrecht ka gewährt oder explizit verweigert sei. Tabelle 18 Die Kompoete des Datetyps Acl Attribut Datetyp Beschreibug etries AclEtry[] Ei Array vo Zugriffsrechte, die dem gegebee Pricipal gewährt oder verweigert werde iherited boolea Dieser Wert ist geau da wahr, we dies ei geerbtes ACL-Objekt ist, d. h. we die Zugriffsrechte vom übergeordete Objekt überomme wurde. Das Objekt, zu dem die geerbte ACL gehört, ist über das Attribut ower verfügbar. ower ObjectId Die OID des VIP-Objekts, zu dem diese ACL gehört 88 VIP WebServices Programmierhadbuch

89 Objektverwaltug Datetyp: AclEtry Dieser Datetyp repräsetiert die Zuordug eies Pricipals zu eiem gewährte oder verweigerte Zugriffsrecht Tabelle 19 Die Kompoete des Datetyps AclEtry Attribut Datetyp Beschreibug permissio Permissio Das Zugriffsrecht, das dem Pricipal vo diesem AclEtry zugewiese wird policy boolea Defiiert, ob dem Pricipal das Zugriffsrecht gewährt (wahr) oder verweigert (falsch) werde soll pricipal Pricipal Der zugehörige Pricipal ACL eies VIP-Objekts äder We Sie die ACL eies VIP-Objekts äder möchte, gehe Sie folgedermaße vor: 1. Erzeuge Sie für jede Pricipal, der i der eue ACL vorkomme soll, ei etsprechedes User-, Group-, Role- bzw. GroupRole- Objekt. 2. Erzeuge Sie für jede Rechteart, die i der ACL defiiert werde soll, ei etsprechedes Permissio-Objekt. 3. Erzeuge Sie mit de agelegte Pricipal- ud Permissio- Objekte für jedes Recht, das gewährt bzw. verweigert werde soll, ei AclEtry-Objekt. I diesem AclEtry-Objekt wird über das Attribut policy gesteuert, ob das Recht gewährt (true) oder verweigert (false) wird. 4. Lege Sie ei Array vo AclEtries a, i das die gerade erzeugte AclEtries eigetrage werde. VIP WebServices Programmierhadbuch 89

90 Kapitel 5 5. Mit diesem Feld wird das etries-attribut eies Acl-Objekts gesetzt, das ower- ud iherited-attribut spiele dabei keie Rolle. 6. Belege Sie folgede Attribute eies ObjectData-Objekts: das ACL-Attribut mit dem erzeugte Acl-Objekt die ObjectId mit der OID des zu äderde VIP-Objekts das Array attributekeys mit dem Attributame ACL 7. Rufe Sie mit diesem ObjectData-Objekt die Methode chage auf, um die eue Rechte für das VIP-Objekt zu setze. Siehe chage auf Seite 106. Datetyp: MultiImportPart Dieser Datetyp diet dazu, eie baumartige Struktur vo VIP-Objekte zu repräsetiere, die vo VIP CotetMaager mit der Methode multiimport agelegt werde köe (siehe multiimport auf Seite 127). Tabelle 20 Die Kompoete des Datetyps MultiImportPart Attribut Datetyp Beschreibug childre MultiImportPart[] Hier werde die uterhalb des aktuelle VIP-Objekts azulegede VIP- Objekte defiiert. Diese Liste wird ur ausgewertet, we das azulegede Objekt de Typ Thema hat. 90 VIP WebServices Programmierhadbuch

91 Objektverwaltug Attribut Datetyp Beschreibug cotet base64biary Der Ihalt des azulegede VIP- Objekts. Hier darf ull stehe, we das Objekt ohe Ihalt agelegt werde soll. Hisichtlich des Ihalts gelte die Regel für de jeweilige Objekttyp: So muss ei Objekt vom Typ Frame zum Beispiel eie frameset-tag ethalte. objectdata ObjectData Hier werde die Metadate des azulegede Objekts defiiert. Folgede Felder müsse dabei gesetzt sei: deploymethit: Der Vorschlag für de Dateiame des geerierte Web-Objekts objecttype: Der Objekttyp des azulegede VIP-Objekts title: Der Titel des VIP-Objekts attributekeys: DieListeder Name der gesetzte Attribute (miimal deploymethit, objecttype, title) VIP WebServices Programmierhadbuch 91

92 Kapitel Allgemeie Parameter Eiige der im Folgede beschriebee Methode verwede die Parameter DeploymetWaitIfo ud WaitIfo. DieseParameter habe immer die gleiche Fuktio ud werde daher ur eimal a dieser Stelle beschriebe. Parameter DeploymetWaitIfo Der Datetyp DeploymetWaitIfo repräsetiert die Iformatioe, die verwedet werde, um auf alle Jobs der Deploymetsysteme zu warte, die zu eier Aktio gehöre. Dieser Datetyp wird i Prozeduraufrufe verwedet, die Workflow-Aktioe astoße. Ist der Parameter DeploymetWaitIfo icht ull, so wartet die aufrufede Methode darauf, dass die i diesem Parameter spezifizierte Deploymetsysteme alle zugehörige Deploymetaufgabe abschließe. Die maximale Wartezeit wird durch DeploymetWaitIfo.timeout defiiert. Die Methode kehrt spätestes zurück, we die Wartezeit für diese Aktioe de agegebee Timeout-Wert überschreitet. We im Aufruf eier Workflow-Methode der Parameter für DeploymetWaitIfo gleich ull ist, wird auf kei Deploymetsystem gewartet. Die Abarbeitug der Deploymetaufgabe geschieht da asychro. 92 VIP WebServices Programmierhadbuch

93 Objektverwaltug Tabelle 21 Die Kompoete des Datetyps DeploymetWaitIfo Attribut Datetyp Beschreibug deploymetsystems Strig[] Eie Liste vo Deploymetsysteme, auf die gewartet werde soll istimeout boolea I VIP WebServices ist dies ei Feld, das für zuküftige Fuktioe reserviert ist. Zum jetzige Zeitpukt hat es keie Bedeutug. timeout log Die maximale Zeit (i Millisekude), die auf die Beedigug der Deploymet-Jobs gewartet wird. Parameter Ifo Der Datetyp Ifo repräsetiert die Iformatioe, die zum automatische Erstelle vo s verwedet werde. Diese s werde bei Vorlage, Freigabe, Lösche ud Ablehe vo VIP-Objekte versedet. Das Sede der s ka auf dem VIP-CM-Server erfolge, we die etsprechede Methode verwedet werde. Der im VIP-CM-Server implemetierte Algorithmus sammelt alle - Adresse aus de Date des VIP-Objekts. Die Aktio defiiert, welche Attribute zur Erzeugug der -Adresse verwedet werde. Die relevate Attribute sid edit receivers, QA Receivers ud release receivers. We im Aufruf eier Workflow-Methode der Parameter für die Ifo gleich ull ist, erzeugt das VIP-CM-System keie s. VIP WebServices Programmierhadbuch 93

94 Kapitel 5 Tabelle 22 Die Kompoete des Datetyps Ifo Attribut Datetyp Beschreibug cc strig Das CC -Feld der . Hier köe zusätzliche Empfäger eigetrage werde. excludeoidlist boolea Dieser Wert ist geau da wahr, we die Liste der OIDs i der erzeugte weggelasse werde soll. subject strig Der Betreff der text strig Der Ihalt der 5.3 Workflow-Methode I diesem Abschitt werde die Methode vo VIP WebServices vorgestellt, mit dee Workflow-Aktioe realisiert werde köe. Ausleihe vo Objekte zur Bearbeitug, siehe checkout auf Seite 96 Ausleihe vo Objekte rückgägig mache, siehe udocheckout auf Seite 102 Zurückgebe vo Objekte ach der Bearbeitug, siehe checki auf Seite 95 Objekte ohe Vorlege direkt freigebe, siehe directrelease auf Seite 97 Objekte zur Qualitätssicherug vorlege, siehe submit auf Seite VIP WebServices Programmierhadbuch

95 Objektverwaltug Objekte i der Qualitätssicherug ablehe, siehe reject auf Seite 99 Objekte i der Qualitätssicherug freigebe, siehe release auf Seite 100 I der folgede Übersicht sid die Methode alphabetisch sortiert. checki Gibt de (modifizierte) Ihalt des agegebee VIP-Objekts a das VIP-CM-System zurück Parameter Tabelle 23 Parameter der Methode checki Parameter Datetyp Beschreibug oid ObjectId Die OID des betreffede VIP- Objekts cotet byte[] Der Ihalt des VIP-Objekts, als Datei spezifiziert keepcheckout boolea Flagge, ob das Objekt ach dem Aufruf weiterhi ausgeliehe bleibe soll remark strig Eie Zeichekette, die zum Protokoll des VIP-Objekts hizugefügt wird, oder ull dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe keie VIP WebServices Programmierhadbuch 95

96 Kapitel 5 Voraussetzuge Erforderliche Zugriffsrechte: READ, WRITE ud WRITE_META Objektstatus: muss CHECKED_OUT sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Folge Nach dem Zurückgebe hat das VIP-Objekt de Status EDITED, fallskeepcheckout de Wert false hatte CHECKED_OUT, fallskeepcheckout de Wert true hatte checkout Leiht das agegebee VIP-Objekt aus Parameter Tabelle 24 Parameter der Methode checkout Parameter Datetyp Beschreibug oid ObjectId Die OID des betreffede VIP- Objekts remark strig Eie Zeichekette, die zum Protokoll des VIP-Objekts hizugefügt wird, oder ull dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe keie 96 VIP WebServices Programmierhadbuch

97 Objektverwaltug Voraussetzuge Erforderliche Zugriffsrechte: READ, WRITE ud WRITE_META Objektstatus: muss EDITED, REJECTED, RELEASED oder PENDING_RELEASE sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Folge Nach dem Ausleihe hat das VIP-Objekt de Status CHECKED_OUT. Hiweis: Um de Objektihalt zu bearbeite, muss aschließed getcheckoutcotet aufgerufe werde, siehe getcheckoutcotet auf Seite 118. directrelease Gibt eie Liste vo VIP-Objekte ohe eie Vorlage zur Qualitätssicherug frei Parameter Tabelle 25 Parameter der Methode directrelease Parameter Datetyp Beschreibug oids ObjectId[] Eie Liste vo OIDs pedreldate datetime Datum ud Uhrzeit, wa die agegebee VIP-Objekte freigegebe werde solle (verzögerte Freigabe) VIP WebServices Programmierhadbuch 97

98 Kapitel 5 Parameter Datetyp Beschreibug remark strig Eie Zeichekette, die zum Protokoll der VIP-Objekte hizugefügt wird, oder ull ifo Ifo Die -Iformatio, die a die i de Objektdate defiierte Empfäger gesedet werde, oder ull, falls keie gesedet werde soll dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe keie Voraussetzuge Erforderliche Zugriffsrechte: READ, RELEASE, WRITE ud WRITE_META Objektstatus: muss EDITED sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Folge Nach der direkte Freigabe hat VIP-Objekt de Status RELEASED bzw. PENDING_RELEASE (falls ei Freigabetermi i der Zukuft agegebe wurde). 98 VIP WebServices Programmierhadbuch

99 Objektverwaltug reject Leht eie Liste vo VIP-Objekte ab Parameter Tabelle 26 Parameter der Methode reject Parameter Datetyp Beschreibug oids ObjectId[] Die Liste der abzulehede OIDs remark strig Eie Zeichekette, die zum Protokoll jedes VIP-Objekts hizugefügt wird, oder ull ifo Ifo Die -Iformatio, die a die i de Objektdate defiierte Empfäger gesedet werde, oder ull, falls keie gesedet werde soll dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe keie Voraussetzuge Erforderliche Zugriffsrechte: RELEASE ud READ Objektstatus: muss SUBMITTED oder DELETED sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server oder QS-Server beachrichtigt wird. Folge Nach dem Ablehe habe die VIP-Objekte de Status REJECTED. VIP WebServices Programmierhadbuch 99

100 Kapitel 5 release Gibt eie Liste vo VIP-Objekte frei Parameter Tabelle 27 Parameter der Methode release Parameter Datetyp Beschreibug oids ObjectId[] Die Liste der freizugebede OIDs remark strig Eie Zeichekette, die zum Protokoll jedes VIP-Objekts hizugefügt wird, oder ull ifo Ifo Die -Iformatio,dieadie i de Objektdate defiierte Empfäger gesedet werde, oder ull, falls keie gesedet werde soll dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe keie Voraussetzuge Erforderliche Zugriffsrechte: RELEASE ud READ Objektstatus: muss SUBMITTED sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server oder QS-Server beachrichtigt wird. 100 VIP WebServices Programmierhadbuch

101 Objektverwaltug Folge Nach der Freigabe habe die VIP-Objekte de Status RELEASED oder PENDING_RELEASE. Der Statuswechsel bei der Freigabe hägt davo ab, ob das Metadatum Verzögerte Freigabe gesetzt ist. submit Legt eie Liste vo VIP-Objekte zur Qualitätssicherug vor Parameter Tabelle 28 Parameter der Methode submit Parameter Datetyp Beschreibug oids ObjectId[] Die OIDs der vorzulegede VIP- Objekte pedreldate datetime Datum ud Uhrzeit bei verzögerter Freigabe oder ull,falls eie sofortige Freigabe ermöglicht werde soll remark strig Eie Zeichekette, die zum Protokoll der VIP-Objekte hizugefügt wird, oder ull ifo Ifo Die -Iformatio, die a die i de Objektdate defiierte Empfäger gesedet werde, oder ull, falls keie gesedet werde soll dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe keie VIP WebServices Programmierhadbuch 101

102 Kapitel 5 Voraussetzuge Erforderliche Zugriffsrechte: READ, WRITE ud WRITE_META Objektstatus: muss EDITED sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Folge Nach dem Vorlege habe die VIP-Objekte de Status SUBMITTED. udocheckout Das Ausleihe der agegebee VIP-Objekte wird rückgägig gemacht. Dadurch sid die Objekte zur Bearbeitug durch adere verfügbar. Parameter Tabelle 29 Parameter der Methode udocheckout Parameter Datetyp Beschreibug oids ObjectId[] Die OIDs der betreffede VIP- Objekte remark strig Eie Zeichekette, die zum Protokoll der VIP-Objekte hizugefügt wird, oder ull dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe keie 102 VIP WebServices Programmierhadbuch

103 Objektverwaltug Voraussetzuge Erforderliche Zugriffsrechte: READ, WRITE ud WRITE_META Objektstatus: muss CHECKED_OUT sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Folge Nachdem die Äderuge a de ausgeliehede VIP-Objekte verworfe wurde, habe die VIP-Objekte de Status EDITED. 5.4 Methode der Objektverwaltug I diesem Abschitt werde die Methode vo VIP WebServices vorgestellt, mit dee VIP-Objekte bearbeitet werde köe. Objekte alege eue Objekte alege, siehe create auf Seite 112 Objekte durch eie Multiimport alege, siehe multiimport auf Seite 127 Objekte erhalte ud bearbeite Objekt mit der agegebee OID i der defiierte Versio lese, siehe get auf Seite 117 Ihalt des VIP-Objekts mit der agegebee OID ud der defiierte Versio erhalte. Der Ihalt wird vom zugeordete Deploymetsystem geeriert. Dabei wird der Ihalt mit de verwedete Vorlage zusammegeführt. Siehe getcheckoutcotet auf Seite 118. VIP WebServices Programmierhadbuch 103

104 Kapitel 5 Ihalt des VIP-Objekts mit der agegebee OID ud der defiierte Versio erhalte, ohe weitere Maipulatioe am Ihalt i Bezug auf die verwedete Vorlage. Siehe getcotet auf Seite 120. Metadate äder, siehe chage auf Seite 106 Positio i der Hierarchie ermittel/sortiere Ermittel der utergeordete Objekte eies Themas, siehe getchildre auf Seite 119 Ermittel des übergeordete Objekts, siehe getparet auf Seite 124 Sortierug vo Elemete, sodass jedes Kid-Objekt hiter seiem Elter-Objekt platziert ist, siehe sortparetsfirst auf Seite 130 Baumoperatioe Objekte kopiere, siehe copy auf Seite 110 Objekt verschiebe, siehe move auf Seite 126 Objekte lösche Objekte lösche (muss vo der Qualitätssicherug bestätigt werde), siehe delete auf Seite 113 Objekte edgültig lösche, siehe destroy auf Seite 114 Protokoll ud Versioe Abfrage vo Protokolleiträge, siehe getlastlogetries auf Seite 122 Bemerkug zum Protokoll hizufüge, siehe addremark auf Seite 106 Versioe eies Objekts aufliste, siehe getversiolist auf Seite VIP WebServices Programmierhadbuch

105 Objektverwaltug ältere Versio eies Objekts wiederherstelle, siehe restoreversio auf Seite 129 Refereze prüfe Prüfug vor dem Lösche, ob die agegebee VIP-Objekte vo adere VIP-Objekte refereziert werde, siehe checkrefereces- ForDelete auf Seite 108 Prüfug vor der Freigabe, ob die agegebee VIP-Objekte adere VIP-Objekte refereziere, die och icht freigegebe wurde, siehe checkreferecesforrelease auf Seite 108 Prüfug vor dem Vorlege, ob die agegebee VIP-Objekte adere VIP-Objekte refereziere, die och icht zur Qualitätssicherug vorgelegt wurde, siehe checkreferecesforsubmit auf Seite 109 Abfrage exterer Refereze, siehe getexteralliks auf Seite 122 Deploymet Web-Objekt(e) erzeuge, siehe geeratepage auf Seite 115 Abfrage verbleibeder Deploymetaufgabe für ei agegebees Deploymetsystem ud ei VIP-Objekt, siehe getdeploymetjobs auf Seite 121 I der folgede Übersicht sid die Methode alphabetisch sortiert. VIP WebServices Programmierhadbuch 105

106 Kapitel 5 addremark Fügt eie Bemerkug zum Protokoll des spezifizierte VIP-Objekts hizu. Parameter Tabelle 30 Parameter der Methode addremark Parameter Datetyp Beschreibug oid ObjectId Die OID des betreffede VIP-Objekts remark strig Eie Zeichekette, die zum Protokoll des VIP- Objekts hizugefügt werde soll, oder ull Rückgabe keie Voraussetzuge Erforderliche Zugriffsrechte: READ ud WRITE_META Objektstatus: keie Eischräkuge Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit- oder QS-Server beachrichtigt wird. Folge Der Objektstatus ädert sich icht. chage Ädert die Metadate eies VIP-Objekts Es köe ur die i Tabelle 11 Die Kompoete des Datetyps ObjectData auf Seite 77 als modifizierbar agegebee Attribute geädert werde. 106 VIP WebServices Programmierhadbuch

107 Objektverwaltug I objectdata.attributekeys müsse alle Attribute agegebe werde, die geädert werde solle. Darüber hiaus muss objectdata.objectid gesetzt sei. Parameter Tabelle 31 Parameter der Methode chage Parameter Datetyp Beschreibug objectdata ObjectData Die geäderte Objektdate remark strig Eie Zeichekette, die zum Protokoll des VIP-Objekts hizugefügt wird, oder ull dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe keie Voraussetzuge Erforderliche Zugriffsrechte: READ ud WRITE_META. Solldie Zugriffssteuerugsliste (ACL) geädert werde, ist zusätzlich das Zugriffsrecht CHANGE_RIGHTS otwedig. Objektstatus: muss EDITED, REJECTED, RELEASED oder PENDING_RELEASE sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Folge Nach der Äderug hat das agegebee VIP-Objekt de Status EDITED. VIP WebServices Programmierhadbuch 107

108 Kapitel 5 checkreferecesfordelete Methode zur Prüfug, ob die agegebee VIP-Objekte vo adere VIP-Objekte refereziert werde. Diese Methode sollte vor dem Lösche oder Zerstöre vo VIP-Objekte aufgerufe werde. Parameter Tabelle 32 Parameter der Methode checkreferecesfordelete Parameter Datetyp Beschreibug oids ObjectId[] Eie Liste vo OIDs, dere zugehörige VIP- Objekte geprüft werde solle Rückgabe ObjectId[] objectids: Eie Liste vo OIDs, welche i oids ethalte sid ud dere zugehörige VIP-Objekte vo adere VIP- Objekte refereziert werde. Voraussetzuge Es sid keie Zugriffsrechte erforderlich Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. checkreferecesforrelease Methode zur Prüfug, ob die agegebee VIP-Objekte adere VIP- Objekte refereziere, die och icht freigegebe wurde. Diese Methode sollte vor dem Freigebe vo VIP-Objekte aufgerufe werde. 108 VIP WebServices Programmierhadbuch

109 Objektverwaltug Parameter Tabelle 33 Parameter der Methode checkreferecesforrelease Parameter Datetyp Beschreibug oids ObjectId[] Eie Liste vo OIDs, dere zugehörige VIP- Objekte geprüft werde solle Rückgabe ObjectId[] objectids: Eie Liste vo OIDs, die i oids ethalte sid ud dere zugehörige VIP-Objekte auf adere VIP-Objekte refereziere, die icht i oids ethalte sid ud och icht freigegebe wurde. Es werde ur solche VIP-Objekte zurückgegebe, die i der QS-Sicht verfügbar sid ud somit midestes eimal der Qualitätssicherug vorgelegt worde sid. Voraussetzuge Es sid keie Zugriffsrechte erforderlich. Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. checkreferecesforsubmit Methode zur Prüfug, ob die agegebee VIP-Objekte adere VIP- Objekte refereziere, die och icht zur Qualitätssicherug vorgelegt wurde. Diese Methode sollte vor dem Vorlege vo VIP-Objekte zur Qualitätssicherug aufgerufe werde. VIP WebServices Programmierhadbuch 109

110 Kapitel 5 Parameter Tabelle 34 Parameter der Methode checkreferecesforsubmit Parameter Datetyp Beschreibug oids ObjectId[] Eie Liste vo OIDs, dere zugehörige VIP- Objekte geprüft werde solle Rückgabe ObjectId[] objectids: EieListevoOIDs,dieioids ethalte sid ud dere zugehörige VIP-Objekte auf adere VIP-Objekte refereziere, die icht i oids ethalte sid ud och icht zur Qualitätssicherug vorgelegt wurde. Voraussetzuge Es sid keie Zugriffsrechte erforderlich. Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich copy Folge Der Objektstatus ädert sich icht. Kopiert ei VIP-Objekt uter ei Thema Das agegebee Objekt darf auch uter das Thema kopiert werde, i dem es sich bereits befidet. Dabei ädert sich der Titel des Objekts icht. Es existiere da zwei Objekte mit gleichem Name. 110 VIP WebServices Programmierhadbuch

111 Objektverwaltug Parameter Tabelle 35 Parameter der Methode copy Parameter Datetyp Beschreibug oid ObjectId Die OID des betreffede VIP- Objekts ewparetoid ObjectId Die OID des Themas, uter das das VIP-Objekt kopiert werde soll. remark strig Eie Zeichekette, die zum Protokoll des VIP-Objekts hizugefügt wird, oder ull dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe ObjectId objectid : Die OID des eue, kopierte VIP-Objekts Voraussetzuge Erforderliche Zugriffsrechte auf das kopierte VIP-Objekt: TREE_OPERATIONS, READ ud WRITE_META Erforderliche Zugriffsrechte auf das Zielthema: CREATE ud READ Objektstatus: muss EDITED, REJECTED, RELEASED oder PENDING_RELEASE sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Folge Der Status des kopierte VIP-Objekts (des Quellobjekts) ädert sich icht. Die eu agelegte Kopie erhält de Status EDITED. VIP WebServices Programmierhadbuch 111

112 Kapitel 5 create Erzeugt ei eues VIP-Objekt mit de agegebee Metadate. Die Vorlage i de Objektdate (objectdata.template) darf ull sei. Parameter Tabelle 36 Parameter der Methode create Parameter Datetyp Beschreibug objectdata ObjectData Für ei eues Objekt müsse zumidest die Attribute: topic, objecttype ud title agegebe werde. Soll das eue VIP- Objekt auf eier Vorlage basiere so ist auch template azugebe. Zugriffsrechte (ACL) köe hier och icht defiiert werde. cotet byte[] Ihalt des Objekts oder ull, falls kei Ihalt agegebe werde soll remark strig Eie Zeichekette, die zum Protokoll des VIP-Objekts hizugefügt wird, oder ull dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe ObjectId objectid: die OID des eu erzeugte VIP-Objekts Voraussetzuge Erforderliche Zugriffsrechte auf dem übergeordete Thema: CREATE, READ, WRITE ud WRITE_META Objektstatus: keie Eischräkuge 112 VIP WebServices Programmierhadbuch

113 Objektverwaltug Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Die beötigte Fuktiosbereiche häge vo dem zu erzeugede Objekttyp ab. Folge Nach dem Alege hat das VIP-Objekt de Status EDITED. delete Löscht die agegebee VIP-Objekte. Wurde ei VIP-Objekt och ie zur Qualitätssicherug vorgelegt, so wird es durch diese Methode vollstädig aus dem VIP-CM-System etfert. Aderefalls erhält es de Objektstatus DELETED ud bleibt weiterhi i der Qualitätssicherug sichtbar. Dort muss das Lösche mit eier destroy-aktio bestätigt oder mittels reject zurückgewiese werde. Parameter Tabelle 37 Parameter der Methode delete Parameter Datetyp Beschreibug oids ObjectId[] Eie Liste vo OIDs remark strig Eie Zeichekette, die zum Protokoll der VIP-Objekte hizugefügt wird, oder ull ifo Ifo Die -Iformatio, die a die i de Objektdate defiierte Empfäger gesedet werde, oder ull, falls keie gesedet werde soll dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull VIP WebServices Programmierhadbuch 113

114 Kapitel 5 Rückgabe keie Voraussetzuge Erforderliche Zugriffsrechte: DELETE, READ, WRITE ud WRITE_META Objektstatus: muss EDITED, REJECTED, RELEASED oder PENDING_RELEASE sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Folge Ist ei VIP-Objekt bereits eimal zur Qualitätssicherug vorgelegt worde, so erhält es ach dem Lösche de Status DELETED. destroy Zerstört die agegebee VIP-Objekte ud bestätigt damit das Lösche durch delete Parameter Tabelle 38 Parameter der Methode destroy Parameter Datetyp Beschreibug oids ObjectId[] Eie Liste vo OIDs remark strig Eie Zeichekette, die zum Protokoll der VIP-Objekte hizugefügt wird, oder ull 114 VIP WebServices Programmierhadbuch

115 Objektverwaltug Parameter Datetyp Beschreibug ifo Ifo Die -Iformatio, die a die i de Objektdate defiierte Empfäger gesedet werde, oder ull, falls keie gesedet werde soll dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe keie Voraussetzuge Erforderliche Zugriffsrechte: READ ud RELEASE Objektstatus: muss DELETED sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit- oder QS-Server beachrichtigt wird. Folge Nach dem Zerstöre ist das VIP-Objekt eischließlich aller alte Versioe icht mehr im VIP-CM-System sichtbar. geeratepage Erzeugt die Web-Objekte zu der agegebee Liste vo VIP-Objekte (Seitegeerierug). Objekte, dere Web-Objekte mithilfe der Fuktio Seite etfere aus der Produktiossicht etfert wurde, köe mit dieser Methode icht eu geeriert werde. Solche Objekte müsse och eimal vollstädig de Workflow durchlaufe, ehe sie wieder veröffetlicht werde köe. VIP WebServices Programmierhadbuch 115

116 Kapitel 5 Parameter Tabelle 39 Parameter der Methode geeratepage Parameter Datetyp Beschreibug deplsystem strig Der Name eies Deploymetsystems oids ObjectId[] Eie Liste vo OIDs usereltempl boolea true, falls die freigegebee Vorlage verwedet werde soll, false für die aktuelle Versio der Vorlage dplwaitif DeploymetWaitIfo Liste der Deploymetsysteme oder ull Rückgabe keie Voraussetzuge Erforderliches Zugriffsrecht: READ Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. 116 VIP WebServices Programmierhadbuch

117 Objektverwaltug get Liefert das VIP-Objekt mit der agegebee OID i der defiierte Versio. Über de Parameter attrkeys ka eie geaue Liste vo Attribute agefordert werde, die ach dem Aufruf der Methode im Rückgabewert verfügbar sid. Parameter Tabelle 40 Parameter der Methode get Parameter Datetyp Beschreibug oid ObjectId Die OID des VIP-Objekts versio Versio Die gewüschte Versio Die Zahl für die aktuelle Versio ka hier icht agegebe werde, ull liefert die aktuelle Versio. attrkeys strig[] Eie Liste der gewüschte Attribute Rückgabe ObjectData objectdata: Die ageforderte Date des spezifizierte VIP-Objekts Voraussetzuge Erforderliche Zugriffsrechte: READ bzw. READ_PRODUCTION Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. VIP WebServices Programmierhadbuch 117

118 Kapitel 5 getcheckoutcotet Liefert de Ihalt des VIP-Objekts mit der agegebee OID ud der defiierte Versio i eiem Byte-Array zurück. Diese Methode ka auch verwedet werde, we das VIP-Objekt icht ausgeliehe ist, d.h. we der Status des VIP-Objekts icht CHECKED_OUT ist. Der Ihalt wird vo dem Deploymetsystem geeriert, das VIP WebServices zugeordet ist. Bei HTML-Objekte ud ähliche Objekttype werde die HEAD-Bereiche der Vorlage zusammegeführt ud i de HEAD-Bereich des Ihalts eigefügt. Der BODY-Bereich wird icht geädert bis auf die ethaltee Refereze, die ggf. auf de eueste Stad gebracht werde. VIP-Tags werde icht ersetzt. Die HEAD-Bereiche werde bei Theme icht zusammegeführt. Bei biäre VIP-Objekte (wie z.b. GIF-Bilder) wird der Ihalt icht geädert. Parameter Tabelle 41 Parameter der Methode getcheckoutcotet Parameter Datetyp Beschreibug oid ObjectId Die OID des VIP-Objekts versio Versio Die gewüschte Versio, ull liefert die aktuelle Versio Rückgabe byte[] cotet: Der ausgeliehee Ihalt des ageforderte VIP- Objekts Voraussetzuge Erforderliches Zugriffsrecht: READ Objektstatus: keie Eischräkuge 118 VIP WebServices Programmierhadbuch

119 Objektverwaltug Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. getchildre Liefert die OIDs der Kid-Objekte des agegebee VIP-Objekts uter der spezifizierte Asicht view Parameter Tabelle 42 Parameter der Methode getchildre Parameter Datetyp Beschreibug oid ObjectId Die OID des VIP-Objekts view it 1 = Themebaumasicht 2 = Vorlageasicht 3 = Verbudobjektasicht Rückgabe ObjectId[] objectids: Eie Liste vo OIDs der ageforderte Kid-Objekte Voraussetzuge Erforderliches Zugriffsrecht: READ Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. VIP WebServices Programmierhadbuch 119

120 Kapitel 5 getcotet Liefert de Ihalt des VIP-Objekts mit der agegebee OID ud der defiierte Versio i eiem Byte-Array zurück. Diese Methode liefert de Ihalt des VIP-Objekts, wie er im VIP Cotet-Repository gespeichert ist, ohe weitere Maipulatioe am Ihalt i Bezug auf die verwedete Vorlage durchzuführe. Hiweis: We das VIP-Objekt keie Ihalt hat, wird beim Aufruf dieser Methode eie Exceptio geworfe. Parameter Tabelle 43 Parameter der Methode getcotet Parameter Datetyp Beschreibug oid ObjectId Die OID des VIP-Objekts versio Versio Die gewüschte Versio, ull liefert de Ihalt der aktuelle Versio Rückgabe byte[] cotet: Der Ihalt des ageforderte VIP-Objekts Voraussetzuge Erforderliches Zugriffsrecht: READ Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. 120 VIP WebServices Programmierhadbuch

121 Objektverwaltug getdeploymetjobs Liefert alle verbleibede Deploymetaufgabe für ei agegebees Deploymetsystem ud ei VIP-Objekt zurück. Jede Workflow-Aktio, die ei VIP-Objekt ädert, erzeugt Deploymetaufgabe für das Deploymetsystem eier Website. Parameter Tabelle 44 Parameter der Methode getdeploymetjobs Parameter Datetyp Beschreibug dplsystem strig Der Name des Deploymetsystems oid ObjectId Die OID des betreffede VIP-Objekts Rückgabe DeploymetJobIfo[] depljobs: Die Liste der verbleibede Deploymetaufgabe. Gibt es keie Aufgabe für die agegebee Parameter, so wird eie leere Liste zurückgeliefert. Voraussetzuge Es sid keie Zugriffsrechte erforderlich. Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. VIP WebServices Programmierhadbuch 121

122 Kapitel 5 getexteralliks Liefert alle extere Refereze, die i der Liste der agegebee VIP-Objekte ethalte sid. Extere Refereze zeige auf URLs außerhalb der VIP-verwaltete Website. Parameter Tabelle 45 Parameter der Methode getexteralliks Datetyp Parameter Beschreibug ObjectId[] oids Die OIDs der zu betrachtede VIP-Objekte Rückgabe LikIfo[] liks: Die Liste der extere Liks Voraussetzuge Erforderliches Zugriffsrecht: READ Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. getlastlogetries Liefert eie Liste vo Protokolleiträge zum agegebee VIP- Objekt. Die Protokolleiträge werde i absteigeder Reihefolge geliefert, begied bei first. 122 VIP WebServices Programmierhadbuch

123 Objektverwaltug Parameter Tabelle 46 Parameter der Methode getlastlogetries Parameter Datetyp Beschreibug oid ObjectId Die OID des VIP-Objekts first it Die Nummer des erste zu lieferde Protokolleitrags; -1 bedeutet begied mit dem letzte Protokolleitrag umber it Die Azahl der zu lieferde Protokolleiträge; -1 bedeutet alle Eiträge bis zum erste Rückgabe LogEtry[] logetries: Die Liste der ageforderte Protokolleiträge Voraussetzuge Erforderliches Zugriffsrecht: READ Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. VIP WebServices Programmierhadbuch 123

124 Kapitel 5 getparet Liefert die OIDs der VIP-Objekte, die i der agegebee Asicht view oberhalb des spezifizierte VIP-Objekts liege ( Paret- Objekte ). Parameter Tabelle 47 Parameter der Methode getparet Parameter Datetyp Beschreibug oid ObjectId Die OID des VIP-Objekts view it 1 = Themebaumasicht 2 = Vorlageasicht 3 = Verbudobjektasicht toroot boolea true, falls alle Elter-Objekte bis zur Wurzel zurückgeliefert werde solle Rückgabe ObjectId[] objectids: Eie Liste vo OIDs der ageforderte Paret-Objekte. Hatte toroot de Wert false, so wird geau ei Objekt zurückgeliefert. Für das Wurzel-Objekt wird eie leere Liste zurückgeliefert. Voraussetzuge Es sid keie Zugriffsrechte erforderlich. Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. 124 VIP WebServices Programmierhadbuch

125 Objektverwaltug getversiolist Liefert die vollstädige Liste aller Versioe des agegebee VIP- Objekts. Parameter Tabelle 48 Parameter der Methode getversiolist Parameter Datetyp Beschreibug oid ObjectId Die OID des betreffede VIP-Objekts Rückgabe Versio[] versios: Die ageforderte Liste aller Versioe zum gegebee VIP-Objekt Voraussetzuge Erforderliches Zugriffsrecht: READ Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. VIP WebServices Programmierhadbuch 125

126 Kapitel 5 move Verschiebt das agegebee VIP-Objekt uter ei aderes Thema Parameter Tabelle 49 Parameter der Methode move Parameter Datetyp Beschreibug oid ObjectId Die OID des betreffede VIP- Objekts ewparetoid ObjectId Die OID des Themas, uter das das VIP-Objekt verschobe werde soll remark strig Eie Zeichekette, die zum Protokoll des VIP-Objekts hizugefügt wird, oder ull dplwaitif DeploymetWaitIfo Das Deploymetsystem, auf das gewartet werde soll, oder ull. Rückgabe keie Voraussetzuge Erforderliche Zugriffsrechte auf das verschobee VIP-Objekt: TREE_OPERATIONS, READ ud WRITE_META Erforderliche Zugriffsrechte auf das Zielthema: CREATE ud READ Objektstatus: muss EDITED, RELEASED oder PENDING_RELEASE sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. 126 VIP WebServices Programmierhadbuch

127 Objektverwaltug Folge Nach dem Verschiebe hat das agegebee VIP-Objekt de Status EDITED. multiimport Erzeugt mehrere eue VIP-Objekte i eiem Aufruf. Hierzu wird das iitiale Objekt (imports.objectdata) agelegt ud aschließed die i imports.childre[] defiierte Objekte. Der Multiimport uterscheidet dabei die folgede Möglichkeite: We das iitiale Objekt eie Ihalt hat (imports.cotet!= ull), so wird dieses als Startseite des Multiimports aufgefasst ud vo de i imports.childre[] agegebee Objekte werde ur die direkt oder idirekt vo diesem VIP-Objekt referezierte Objekte agelegt. Hat das iitiale Objekt keie Ihalt, werde alle übergebee Objekte agelegt. Beim Alege der eizele Objekte werde explizite Hyperliks i die bestehede Website ud relative Hyperliks auf mit importierte Objekte erkat ud i die Referezeverwaltug vo VIP CotetMaager überomme. VIP WebServices Programmierhadbuch 127

128 Kapitel 5 Parameter Tabelle 50 Parameter der Methode multiimport Parameter Datetyp Beschreibug iitial Data ObjectData Hier werde das Thema (topic), der Objekttyp (objecttype), der Vorschlag für de Dateiame (deploymethit) uddertitel (title) des eu azulegede Objekts agegebe. Alle adere Attribute werde automatisch für die utergeordete Objekte überomme ud überschreibe die i imports.childre[].objectdata agegebee Werte. So ist es z.b. möglich, eiheitliche Attribute für alle Objekte vorzugebe. Attribute, die ur für das Startobjekt des Multiimports gelte, sollte Sie i imports.childre[0].objectdata festlege. Der Multiimport erzeugt ei eigees Thema, we iitialdata.objecttype vom Typ Thema ist. Aderefalls werde die azulegede Objekte uterhalb des Themas iitialdata.topic agelegt. imports MultiImportPart Metadate, Ihalt ud utergeordete Objekte Siehe Datetyp: MultiImportPart auf Seite 90 remark strig Zeichekette, die zum Protokoll sämtlicher erzeugter VIP-Objekte hizugefügt wird, oder ull dplwaitif DeploymetWait Ifo Liste der Deploymetsysteme oder ull 128 VIP WebServices Programmierhadbuch

129 Objektverwaltug Rückgabe ObjectId objectid: die OID des Startobjekts für demultiimport Voraussetzuge Erforderliche Zugriffsrechte auf dem übergeordete Thema: CREATE, READ, WRITE ud WRITE_META Objektstatus: keie Eischräkuge Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Die beötigte Fuktiosbereiche häge vo de zu erzeugede Objekttype ab. Folge Nach dem Multiimport habe sämtliche eu agelegte VIP-Objekte de Status EDITED. restoreversio Holt eie ältere Versio des agegebee VIP-Objekts zurück. Parameter Tabelle 51 Parameter der Methode restoreversio Parameter Datetyp Beschreibug oid ObjectId Die OID des betreffede VIP- Objekts versio Versio Die gewüschte Versio des VIP- Objekts VIP WebServices Programmierhadbuch 129

130 Kapitel 5 Parameter Datetyp Beschreibug remark strig Eie Zeichekette, die zum Protokoll des VIP-Objekts hizugefügt wird, oder ull dplwaitif DeploymetWaitIfo Das Deploymetsystem, auf das gewartet werde soll, oder ull Rückgabe keie Voraussetzuge Erforderliche Zugriffsrechte: READ, WRITE ud WRITE_META Objektstatus: muss EDITED, REJECTED, RELEASED oder PENDING_RELEASE sei Diese Methode ist ur verfügbar, we der PortalMaager- Server vo eiem Edit-Server beachrichtigt wird. Folge Nach der Wiederherstellug der agegebee Versio hat das VIP- Objekt de Status EDITED. sortparetsfirst Liefert eie Liste zurück, i der jedes Kid-Objekt bezoge auf die spezifizierte Asicht view hiter seiem direkte Elter-Objekt platziert ist. Diese Methode ist ützlich, um VIP-Objekte zu sortiere, die zur Qualitätssicherug vorgelegt oder freigegebe werde solle. 130 VIP WebServices Programmierhadbuch

131 Objektverwaltug Parameter Tabelle 52 Parameter der Methode SortParetsFirst Parameter Datetyp Beschreibug oids ObjectId[] Die OIDs der zu sortierede VIP-Objekte view it 1 = Themebaumasicht 2 = Vorlageasicht 3 = Verbudobjektasicht Rückgabe ObjectId[] objectids: Eie Liste, die die eu sortierte OIDs ethält Voraussetzuge Es sid keie Zugriffsrechte erforderlich Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. VIP WebServices Programmierhadbuch 131

132 Kapitel Suche ach VIP-Objekte Die Suche ach VIP-Objekte wird durch die Methode filter ermöglicht. Eie Suchbedigug wird dabei als ei Datum vom Typ Filter repräsetiert. Mit de auf dem Typ Filter basierede Datetype lasse sich logische Ausrücke modelliere. Dabei köe mithilfe vo Verküpfuge komplexe Filter zusammegestellt werde. Es gibt es verschiedee Kategorie vo Filtertype. Filter, die auf de Attribute der VIP-Objekte basiere (Iformatioe zu suchbare Attribute ethält Tabelle 11 Die Kompoete des Datetyps ObjectData auf Seite 77). Diese Filter sid vom Typ IsNullFilter, JoiFilter oder erweiter de Datetyp ValueFilter. Filter, die scho vorhadee Filter logisch miteiader verküpfe ud dadurch die Kostruktio vo komplexe Suchafrage ermögliche. Folgede Filtertype gehöre zu dieser Kategorie: NotFilter, AdFilter ud OrFilter. Filter, die eie vordefiierte Suchfuktio ausführe: RootTemplateFilter, PermissioFilter, SubtreeFilter ud PricipalFilter. Die folgede Übersicht veraschaulicht de Datetyp Filter ud davo abgeleitete Filtertype. 132 VIP WebServices Programmierhadbuch

133 Objektverwaltug Filter IsNullFilter JoiFilter NotFilter SubtreeFilter ValueFilter RootTemplate Filter Permissio Filter PricipalFilter BiaryFilter GreaterFilter EqualFilter LessFilter LikeFilter AdFilter OrFilter GreaterOrEqual Filter NotEqualFilter LessOrEqual Filter StrigCotais Filter Abb. 7 Der Datetyp Filter ud davo abgeleitete spezielle Filtertype Attributwerte-Filter (ValueFilter) VIP CotetMaager verwaltet die Date eier Website (eischließlich der Ihalte ud der Metadate) i eier Datebak. Bei der Suche wird auf Basis eies Filters eie für das jeweilige Datebaksystem geeigete Suchafrage (eie SQL-Aweisug der Form SELECT... FROM... WHERE... ORDER BY...) formuliert. Die Attributame etspreche de Kompoeteame des Datetyps ObjectData. Es gibt jedoch eiige Eischräkuge bezüglich der Verwedug vo Attribute für die Formulierug vo SQL-Afrage. Aus diesem Grud köe icht alle Attribute i eier Suche verwedet werde. Geaue Agabe zu de suchbare Attribute fide Sie i Tabelle 11 Die Kompoete des Datetyps ObjectData auf Seite 77. Ahad der folgede Tabelle ka abgelese werde, welche Attributtype mit welche Filtertype zusamme verwedet werde köe. VIP WebServices Programmierhadbuch 133

134 Kapitel 5 Tabelle 53 Attributtype ud Filter LikeFilter StrigCotaisFilter IsNullFilter a JoiFilter b EqualFilter NotEqualFilter GreaterFilter GreaterOrEqualFilter LessFilter LessOrEqualFilter ItegerValue, LogValue ListValue c, SetValue c (a) DateValue BooleaValue StrigValue LocaleValue d, ObjectId, ObjectType, ObjectState, User d, Versio Mit diesem Filter ka getestet werde, ob der Wert für ei Attribut gesetzt wurde. (b) Dieser Filtervergleicht zwei Attributwerte miteiader. Beide Werte müsse vom gleiche Typ sei. (c) Gesucht wird jeweils ach eiem Eitrag aus der Liste, der als StrigValue agegebe wird. (d) Bei LocaleValue ud User ka der Wert auch als StrigValue agegebe werde, dadurch köe auch die adere Filter verwedet werde. 134 VIP WebServices Programmierhadbuch

135 Objektverwaltug Beispiele ew IsNullFilter( subtitle ) ew StrigCotaisFilter( QA Receivers, ew StrigValue( jstei@compay.com )) ew LikeFilter( QA *, ew StrigValue( jstei@* )) ew EqualFilter( createdby, ew StrigValue("jstei")) Vordefiierte Suchfuktioe als Filter Der Filtertyp RootTemplateFilter sucht alle VIP-Objekte eier Website, die vom Objekttyp Vorlage sid ud die selbst keie Vorlage besitze. Der Filtertyp PermissioFilter sucht ach alle VIP-Objekte, bei dee ei vorgegebeer Beutzer mit eiem vorgegebee Recht i die Zugriffssteuerugsliste eigetrage wurde. Mit dem Filtertyp SubtreeFilter köe alle VIP-Objekte uterhalb eies gegebee VIP-Objekts (Thema i der Themestruktur bzw. Vorlage i der Vorlagestruktur) ermittelt werde. Der SubtreeFilter ka auch ohe Agabe des Topology-Parameters verwedet werde. I diesem Fall gilt die Themestruktur als Defaultwert. Der Filtertyp PricipalFilter sucht ach VIP-Objekte, dee ei bestimmter Pricipal (Beutzer, Gruppe oder Rolle) zugeordet ist. Zusätzlich besteht die Möglichkeit, das Ergebis auf VIP-Objekte eizuschräke, für die der Pricipal ei bestimmtes Recht (Permissio) besitzt. Weitere Iformatioe zu Pricipals fide Sie u.a. i Abschitt 4.1 Beutzer, Gruppe ud Rolle auf Seite 52. VIP WebServices Programmierhadbuch 135

136 Kapitel 5 Beispiele Der folgede Filter sucht alle VIP-Objekte, die der Beutzer jstei lese darf. ew PermissioFilter(ew Permissio( r ), ew User("jstei") ) Mit dem folgede Filter werde alle VIP-Objekte (eischließlich des spezifizierte Startkotes) zurückgegebe, die i der Themestruktur uter dem VIP-Objekt mit der OID 4711 liege. ew SubtreeFilter(ew ObjectId("4711") ) Die Methode filter Diese Methode fidet Objekte, die dem defiierte Filterkriterium etspreche, uter dem agegebee Thema. Das Ergebis ka sortiert werde durch Spezifiziere eier Liste vo Sortierobjekte, die die zu sortierede Attribute ud die Sortierreihefolge festlegt. Es ist außerdem möglich, Spezialattribute zur Kostruktio eies Suchfilters zu verwede. Hiweis: Bei der Agabe vo Spezialattribute für die Sortierug der Ergebisliste arbeitet die filter-methode zurzeit och icht eiwadfrei. VIP-Objekte, für die der Beutzer der Methode keie Leserechte hat, werde automatisch vo der Suche ausgeschlosse. Das VIP-Objekt, das als Startpukt der Suche defiiert wird, muss ei Thema sei. 136 VIP WebServices Programmierhadbuch

137 Objektverwaltug Die Ergebismege ka durch startres ud umres begrezt werde. Parameter Tabelle 54 Parameter der Methode filter Parameter Datetyp Beschreibug filter Filter Das Suchkriterium oder ull, umachalle Objekte zu suche startoid ObjectId Durch die Agabe der OID eies Startkotes erfolgt die Suche erst uterhalb des agegebee VIP-Objekts. I diesem Fall werde der Startkote startoid selbst sowie alle i der Themestruktur utergeordete VIP-Objekte berücksichtigt. Die startoid muss ei VIP-Objekt vom Typ Thema refereziere. sortlist Sort[] Eie Liste vo Attributkostate, ach dee die Ergebismege sortiert werde soll. Stadardmäßig werde die gefudee VIP-Objekte ach der OID sortiert. startres it Eie Zahl, die das erste Elemet des Suchresultats agibt (meistes 0) umres it Die Azahl der zurückzulieferde Suchresultate, begied bei startresult. -1für alle Resultate attrkeys strig[] Die Name aller Attribute, die i de zurückgelieferte Objektdate gesetzt sei solle Rückgabe ObjectData[] objectdata: Eie Liste vo Objektdate. Dies sid die Date der VIP-Objekte, auf die das agegebee Suchkriterium passt. VIP WebServices Programmierhadbuch 137

138 Kapitel 5 Voraussetzuge Erforderliches Zugriffsrecht: READ Objektstatus: keie Eischräkuge Beachrichtigug des PortalMaager-Servers über alle Servertype möglich Folge Der Objektstatus ädert sich icht. 138 VIP WebServices Programmierhadbuch

139 Objektverwaltug VIP WebServices Programmierhadbuch 139

141 KAPITEL 6 6Awedugsbeispiele Ei zetrales Aliege der Web-Service-Techologie sid das eifache Auffide sowie die eifache Verwedug eies Web-Service. Der erste Pukt wird vo UDDI überomme ud ist icht Thema dieses Hadbuchs. Da sich Web-Services durch WSDL selbst beschreibe, gibt es vo viele Hersteller Werkzeuge, die eie Web-Service-Defiitio eilese ud automatisch i ei für eie Cliet-Awedug utzbares Modul umwadel. Als Awedugsetwickler bide Sie dieses Modul i Ihre Etwicklugsumgebug ei ud schreibe Ihre Awedug i der vo dem Werkzeug uterstützte Programmiersprache. I diesem Kapitel wird a zwei Beispiele gezeigt, wie VIP WebServices geutzt werde ka. Aus der große Vielfalt vo Programmiersprache, die Web-Services utze köe, werde hier VisualBasic for Applicatios (VBA) stellvertreted für icht objekt-orietierte Skriptsprache sowie C# im Zusammespiel mit VisualStudio.NET für die Beispiele beutzt. Es ist icht Ziel dieses Kapitels, eie Programmierkurs für diesesprache zu biete, soder vielmehr auf die Besoderheite im Zusammehag mit ihrer Nutzug hizuweise sowie prototypisch lauffähige Code zu präsetiere. Die Beispiele beziehe sich auf die fiktive Website IteretSite der Firma compay.com : VIP WebServices Programmierhadbuch 141

142 Kapitel 6 Beispiel 1 demostriert, wie komplexe Filterausdrücke formuliert ud die Ergebismege bearbeitet werde. Beispiel 2 zeigt, wie die Workflow-Fuktioe vo VIP CotetMaager geutzt werde. Im Rahme dieser Beispiele lere Sie auch, wie i de beide Programmierumgebuge die Authetifizierug, das Sessio-Maagemet ud die Fehlerbehadlug gehadhabt werde. 6.1 VisualBasic for Applicatios VisualBasic for Applicatios wird immer da eigesetzt, we eue Fuktioe i Microsoft Office-Aweduge itegriert werde solle. Zur Nutzug vo Web-Services stellt Microsoft das so geate SOAP- Toolkit zur Verfügug. Dieser muss auf de Cliet-Recher istalliert werde. Das SOAP-Toolkit ist für de korrekte Versad ud Empfag der SOAP-Nachrichte zustädig, de XML-Ihalt müsse Sie als Awedugsetwickler geeriere. Daher lasse sich die i diesem Kapitel beschriebee Techike auch auf adere Skriptsprache übertrage. Aufbau eies Web-Service-Aufrufs Zur Vorbereitug soll zuächst der Aufbau eies Web-Service-Aufrufs erläutert werde: Jeder Aufruf begit jeweils mit dem SOAP-Evelope, gefolgt vom SOAP- Body. Dieser ethält geau ei Elemet, repräsetiert durch de Name der aufzurufede Methode. Dieses Elemet ethält wiederum die Parameter der Methode. Leere Parameter dürfe dabei weggelasse werde. 142 VIP WebServices Programmierhadbuch

143 Awedugsbeispiele Das folgede Beispiel zeigt eie vollstädige Request (iklusive HTTP- Header), wie er im.net Framework SDK vo Microsoft für de Methodeaufruf filter('objecttype == PDF',...) erzeugt wird: POST /vip8.1/webservice/port/iteretsite/edit HTTP/1.1 User-Aget: Mozilla/4.0 (compatible; MSIE 6.0; MS Web Services Cliet Protocol ) Cotet-Type: text/xml; charset=utf-8 SOAPActio: " Authorizatio: Basic YWRtaW46YQ== Cotet-Legth: 1820 Expect: 100-cotiue Host: vipserver.compay.com Cookie: JSESSIONID=B8D157BC6E214885EE2A2A3A0FA788C8 <?xml versio="1.0" ecodig="utf-8"?> <soap:evelope xmls:soap=" xmls:soapec=" xmls:ts=" xmls:types=" xmls:xsi=" xmls:xsd=" <soap:body soap:ecodigstyle=" <ts:filter> <filter href="#id1" /> <startoid href="#id2" /> <sortlist href="#id3" /> <startresult xsi:type="xsd:it">0</startresult> <umberofresults xsi:type="xsd:it">5</umberofresults> <attributekeys href="#id4" /> </ts:filter> <ts:equalfilter id="id1" xsi:type="ts:equalfilter"> <key href="#id5" /> <value href="#id6" /> <casesesitive xsi:type="xsd:boolea">false</casesesitive> </ts:equalfilter> <ts:objectid id="id2" xsi:type="ts:objectid"> <id xsi:type="xsd:strig">1 </id> </ts:objectid> <soapec:array id="id3" soapec:arraytype="ts:sort[1]"> <Item href="#id7" /> VIP WebServices Programmierhadbuch 143

144 Kapitel 6 </soapec:array> <soapec:array id="id4" soapec:arraytype="xsd:strig[4]"> <Item>createdDate</Item> <Item>objectId </Item> <Item>objectState</Item> <Item>title </Item> </soapec:array> <ts:key id="id5" xsi:type="ts:key"> <strigvalue xsi:type="xsd:strig">objecttype</strigvalue> </ts:key> <ts:objecttype id="id6" xsi:type="ts:objecttype"> <ame xsi:type="xsd:strig">pdf</ame> <template xsi:type="xsd:boolea">false</template> <topic xsi:type="xsd:boolea">false </topic> <frame xsi:type="xsd:boolea">false </frame> <fileocreateneeded xsi:type="xsd:boolea">false </fileocreateneeded> </ts:objecttype> <ts:sort id="id7" xsi:type="ts:sort"> <strigvalue xsi:type="xsd:strig">createddate</strigvalue> <descedig xsi:type="xsd:boolea">false </descedig> </ts:sort> </soap:body> </soap:evelope> Dieses Beispiel ist sehr komplex. Die Ursache hierfür liegt i dem allgemeie Lösugsasatz, de das.net Framework SDK (wie adere Toolkits auch) für die Serialisierug vo Objekte i XML wählt: Es wird versucht, gleiche Objekte ur geau eimal zu serialisiere. Das ist icht zwiged erforderlich. Deshalb ka ei äquivaleter SOAP-Befehl auch so eifach aussehe: POST /vip8.1/webservice/port/iteretsite/edit HTTP/1.1 Authorizatio: Basic YWRtaW46YQ== Cotet-Type: text/xml Host: vipserver.compay.com SOAPActio: " "Cotet-Legth: 1378 <?xml versio="1.0" ecodig="utf-8" stadaloe="o"?> <SOAP-ENV:Evelope xmls:soap-env=" xmls:soap-enc=" xmls:xsi=" 144 VIP WebServices Programmierhadbuch

145 Awedugsbeispiele xmls:xsd=" xmls:vip=" <SOAP-ENV:Body> <SOAPSDK1:filter xmls:soapsdk1=" <filter xsi:type="vip:equalfilter"> <key xsi:type="vip:key"> <strigvalue xsi:type="xsd:strig">objecttype</strigvalue> </key> <value xsi:type="vip:objecttype"> <ame type="xsd:strig">pdf</ame> </value> </filter> <startoid xsi:type="vip:objectid"> <id xsi:type="xsd:strig">1</id> </startoid> <sortlist xsi:type="soap-enc:array" SOAP-ENC:arrayType="vip:Sort[1]"> <Item xsi:type="vip:sort"> <strigvalue xsi:type="xsd:strig"> createddate</strigvalue> <descedig xsi:type="xsd:boolea">false </descedig> </Item> </sortlist> <startresult xsi:type="xsd:it">0</startresult> <umberofresults xsi:type="xsd:it">5</umberofresults> <attributekeys xsi:type="soap-enc:array" SOAP-ENC:arrayType="xsd:strig[4]"> <Item xsi:type="xsd:strig">createddate </Item> <Item xsi:type="xsd:strig">objectid </Item> <Item xsi:type="xsd:strig">objectstate </Item> <Item xsi:type="xsd:strig">title </Item> </attributekeys> </SOAPSDK1:filter> </SOAP-ENV:Body> </SOAP-ENV:Evelope> I de folgede Abschitte werde wir die Kostruktio solcher eifach formulierte SOAP-Befehle demostriere. Die vom Server ebefalls als SOAP-Evelope empfagee Atwort ist midestes geauso komplex wie die obe abgedruckte Afrage. Hier lässt sich die Komplexität leider icht steuer. Der aufwedigere Teil des Programmierbeispiels behadelt deshalb die Deserialisierug der empfagee Date. VIP WebServices Programmierhadbuch 145

146 Kapitel 6 HTTP/ Cotiue HTTP/ OK Cotet-Type: text/xml; charset=utf-8 Cotet-Legth: 4151 Date: Thu, 18 Apr :30:32 GMT Server: Apache Tomcat/4.0.3 (HTTP/1.1 Coector) <?xml versio="1.0" ecodig="utf-8"?> <SOAP-ENV:Evelope SOAP-ENV:ecodigStyle=" xmls:soap-env=" xmls:xsd=" xmls:xsi=" <SOAP-ENV:Body> <s1:filterrespose SOAP-ENV:ecodigStyle=" xmls:s1=" <filterresult xsi:type="soap-enc:array" SOAP-ENC:arrayType="s1:ObjectData[5]" xmls:soap-enc=" <item href="#id1"/> <item href="#id2"/> <item href="#id3"/> <item href="#id4"/> <item href="#id5"/> </filterresult> </s1:filterrespose> <multiref id="id5" SOAP-ENC:root="0" xsi:type="s3:objectdata" xmls:s3=" xmls:soap-enc=" <createddate xsi:type="xsd:datetime"> t16:45:32.000z </createddate> <objectid href="#id6"/> <objectstate href="#id7"/> <title xsi:type="xsd:strig">8.0.1_portalmaagerprogrammersmaual_e </title> </multiref> <multiref id="id2" SOAP-ENC:root="0" xsi:type="s4:objectdata" xmls:s4=" xmls:soap-enc=" <createddate xsi:type="xsd:datetime"> t16:45:08.000z </createddate> <objectid href="#id8"/> <objectstate href="#id7"/> 146 VIP WebServices Programmierhadbuch

147 Awedugsbeispiele <title xsi:type="xsd:strig">8.0.1_cotetmaagerprogrammersmaual_e </title> </multiref> <multiref id="id4" SOAP-ENC:root="0" xsi:type="s5:objectdata" xmls:s5=" xmls:soap-enc=" <createddate xsi:type="xsd:datetime"> t16:45:24.000z </createddate> <objectid href="#id9"/> <objectstate href="#id7"/> <title xsi:type="xsd:strig">8.0.1_cotetmiermaual_e </title> </multiref> <multiref id="id3" SOAP-ENC:root="0" xsi:type="s6:objectdata" xmls:s6=" xmls:soap-enc=" <createddate xsi:type="xsd:datetime"> t16:45:18.000z </createddate> <objectid href="#id10"/> <objectstate href="#id7"/> <title xsi:type="xsd:strig">8.0.1_cotetmaagerusermaual_e </title> </multiref> <multiref id="id1" SOAP-ENC:root="0" xsi:type="s7:objectdata" xmls:s7=" xmls:soap-enc=" <createddate xsi:type="xsd:datetime"> t16:45:06.000z </createddate> <objectid href="#id11"/> <objectstate href="#id7"/> <title xsi:type="xsd:strig">vipnote20_pomamigratio_e </title> </multiref> <multiref id="id6" SOAP-ENC:root="0" xsi:type="s8:objectid" xmls:s8=" xmls:soap-enc=" <id xsi:type="xsd:strig">62</id> </multiref> <multiref id="id9" SOAP-ENC:root="0" xsi:type="s9:objectid" xmls:s9=" xmls:soap-enc=" <id xsi:type="xsd:strig">61</id> </multiref> <multiref id="id10" SOAP-ENC:root="0" xsi:type="s10:objectid" xmls:s10=" xmls:soap-enc=" <id xsi:type="xsd:strig">60</id> VIP WebServices Programmierhadbuch 147

148 Kapitel 6 </multiref> <multiref id="id8" SOAP-ENC:root="0" xsi:type="s11:objectid" xmls:s11=" xmls:soap-enc=" <id xsi:type="xsd:strig">59</id> </multiref> <multiref id="id7" SOAP-ENC:root="0" xsi:type="s12:objectstate" xmls:s12=" xmls:soap-enc=" <ame xsi:type="xsd:strig">edited </ame> <descriptio xsi:type="xsd:strig">geädert</descriptio> <imageurl xsi:type="xsd:strig"> objectstate/chaged.gif </imageurl> </multiref> <multiref id="id11" SOAP-ENC:root="0" xsi:type="s13:objectid" xmls:s13=" xmls:soap-enc=" <id xsi:type="xsd:strig">58</id> </multiref> </SOAP-ENV:Body> </SOAP-ENV:Evelope> Vorarbeite Das SOAP-Toolkit steht uter xml/soap/2.0/w98nt42kme/en-us/soaptoolkit20.exe zum Dowload zur Verfügug. Es beihaltet die Versio 3 (MSXML3) des Microsoft XML- Parsers. We Sie beispielsweise ei Add-I für Microsoft Word erstelle wolle, lege Sie i Word eie Dokumetvorlage a ud öffe de VisualBasic-Editor mit ALT+ F11. Das SOAP-Toolkit sowie de XML- Parser müsse Sie als Verweise (im Meü Extras Verweise) eitrage: 148 VIP WebServices Programmierhadbuch

149 Awedugsbeispiele Abb. 8 Eibidug der Bibliotheke im VisualBasic Editor Architektur der VBA-Awedug Die folgede Klassemodule werde defiiert: VIP WebServices Programmierhadbuch 149

150 Kapitel 6 Tabelle 55 Klassemodule Name Beschreibug VIP-Objekttyp VipWebServiceCliet ObjectId ObjectState ObjectType GeericFilter User Schittstelle zur Nutzug vo VIP WebServices. Nebe der Iitialisierug uter Agabe der Service-URL, des Beutzers ud seies Kewortes stellt dieses Modul alle i VIP WebServices defiierte Methode als Fuktioe zur Verfügug. Kapselt die OID eies VIP- Objekts Erlaubt Serialisierug ud Deserialisierug Kapselt de Status eies VIP- Objekts Erlaubt Serialisierug ud Deserialisierug Kapselt de Typ eies VIP- Objekts Erlaubt Serialisierug ud Deserialisierug Erzeugt die XML-Serialisierug der VIP-Filter-Objekte. Da es i VBA keie Vererbug gibt, ist die Implemetierug etwas aufwedig Serialisiert ud deserialisiert die VIP-User-Objekte ObjectId ObjectState ObjectType *Filter (sämtliche VIP-Filter) User 150 VIP WebServices Programmierhadbuch

151 Awedugsbeispiele Name Beschreibug VIP-Objekttyp Value Versio Locale Serialisiert ud deserialisiert die VIP-Value-Objekte Serialisiert ud deserialisiert die VIP-Versio-Objekte Serialisiert ud deserialisiert die Java-Locale-Objekte *Value (StrigValue, DateValue, LogValue...) Versio Locale Verbidugsaufbau (Modul VipWebServiceCliet) Der Web-Service der Website IteretSite steht uter der URL vipserver.compay.com/vip8/webservice/port/iteretsite/edit zur Verfügug. Ersetze Sie dabei bitte die eizele Bestadteile der URL durch die Werte i Ihrer Kofiguratio. Der SoapCoector beötigt die folgede Properties: EdPoitURL AuthUser (Beutzerkeug des VIP-Beutzers, der auf die Date zugreife soll) AuthPassword (Passwort des VIP-Beutzers) ' ' VipWebServiceCliet ' ' SOAP Ecodig Namespace URI Private Cost SOAP_ENCODING_NS_URI = _ " Private Cost VIP_NAMESPACE_URI = " ' istace variables Private serializer As SoapSerializer VIP WebServices Programmierhadbuch 151

152 Kapitel 6 Private Coector As SoapCoector ' ' iitialize_coectio ' Private Sub iitialize_coectio() If Coector Is Nothig The Set Coector = New HttpCoector ' set "EdPoitURL" Coector.Property("EdPoitURL") = _ " ' set "SoapActio", "AuthUser" ad "AuthPassword" Coector.Property("SoapActio") = VIP_NAMESPACE_URI Coector.Property("AuthUser") = "admi" Coector.Property("AuthPassword") = "a" Else Coector.Reset Ed If ' iitialise the SoapCoector Objekt ad prepare the coectio Coector.Coect ' Begi the SOAP Message Coector.BegiMessage ' create the ecessary SoapSerializer Set serializer = New SoapSerializer ' coect the Serializer with the SOAP Coectio serializer.iit Coector.IputStream ' Begi the SOAP Evelope serializer.startevelope ' add the followig required XML Namespace defiitios: serializer.soapattribute "xmls:soap-enc",, SOAP_ENCODING_NS_URI serializer.soapattribute "xmls:xsi",, _ " serializer.soapattribute "xmls:xsd",, _ " serializer.soapattribute "xmls:vip",, VIP_NAMESPACE_URI ' Begi the request body serializer.startbody Ed Sub 152 VIP WebServices Programmierhadbuch

153 Awedugsbeispiele Hiweise: Das SOAP Toolkit uterstützt leider keie Sessio-Verwaltug über Cookies. VIP WebServices führt deshalb für jede Request eie separate Ameldug durch. Für alle Fuktioe, die Date veräder (zum Beispiel Vorlege) wird eie gültige VIP-Beutzerlizez beötigt. VIP WebServices gibt diese Lizez mit Ablauf des Sessio-Timeouts automatisch wieder frei spätestes aber ach Ablauf des für de Admiistratiosserver eigestellte Ablaufitervalls ach der letzte feststellbare Aktivität des Beutzers. Iformatioe zur Kofiguratio des Ablaufitervalls fide Sie im VIP CotetMaager-Admiistratorhadbuch. Zur Vermeidug vo Lizezprobleme sollte Sie die logout()-methode vo VIP WebServices zur explizite Lizezfreigabe verwede. Aufruf eier Methode ohe Rückgabewert Nach der Iitialisierug des SoapSerializer ka direkt die Methode mitsamt ihre Parameter i de Datestrom eigefügt werde. Dies wird im folgede Code-Beispiel am Beispiel der Methode submit (Vorlege) gezeigt: ' Submit a array of VIP objects (idetified by their ObjectIDs) to QA Public Fuctio submit(byref oids() As ObjectID, _ ByVal pedigreleasedate As Date, _ ByVal remark As Strig, _ ByVal i As ifo, _ ByVal dplwaitifo As DeploymetWaitIfo) As Boolea Dim success As Boolea success = False iitialize_coectio ' serialize request for submit serializer.startelemet "submit", VIP_NAMESPACE_URI ' Start elemet "oids" ' serializer.startelemet "oids" serializer.soapattribute "xsi:type",, "SOAP-ENC:Array" VIP WebServices Programmierhadbuch 153

154 Kapitel 6 serializer.soapattribute "SOAP-ENC:arrayType",, _ "vip:objectid[" & (UBoud(oids) LBoud(oids)) & "]" Dim arrayofoids As New Value Let arrayofoids.arrayvalue = oids serializer.writexml arrayofoids.xml serializer.edelemet ' Start elemet "pedigreleasedate" ' serializer.startelemet "pedigreleasedate" Dim v As New Value Let v.datevalue = pedigreleasedate ' pedigreleasedate is oly valid if it's i the future If pedigreleasedate > Now The serializer.soapattribute "xsi:type",, "xsd:datetime" serializer.writestrig v.simplexml Else serializer.soapattribute "xsi:il",, "true" Ed If serializer.edelemet ' Start elemet "remark" ' serializer.startelemet "remark" serializer.soapattribute "xsi:type",, "xsd:strig" serializer.writestrig remark serializer.edelemet ' Start elemet " ifo" ' serializer.startelemet " ifo" If Not i Is Nothig The serializer.soapattribute "xsi:type",, "vip: ifo" serializer.writexml i.xml Else serializer.soapattribute "xsi:il",, "true" Ed If serializer.edelemet ' Start elemet "dplwaitifo" ' serializer.startelemet "dplwaitifo" If Not dplwaitifo Is Nothig The serializer.soapattribute "xsi:type",, "vip:deploymetwaitifo" serializer.writexml dplwaitifo.xml Else serializer.soapattribute "xsi:il",, "true" Ed If serializer.edelemet serializer.edelemet 154 VIP WebServices Programmierhadbuch

155 Awedugsbeispiele ' ed of SOAP-Body serializer.edbody ' ed of SOAP-Evelope serializer.edevelope ' ed of SOAP message Coector.EdMessage ' create a ew SoapReader Dim Reader As New SoapReader ' Load XML from OutputStream & display a error o failure If Not Reader.Load(Coector.OutputStream) The Dim reaso As Strig reaso = IIf(Reader.dom.parseError Is Nothig, _ "parser: ukow reaso", _ Reader.dom.parseError.reaso) MsgBox "submit failed:- " & reaso, vbexclamatio, "Error" Exit Fuctio Ed If ' if there is a applicatio fault use a message box to report it If Not Reader.Fault Is Nothig The MsgBox "submit failed:- " & _ Reader.faultstrig.odeTypedValue,_ vbexclamatio, "Error" ElseIf Not Reader.Body Is Nothig The submit = True Ed If Ed Fuctio Diese Fuktio zeigt sehr aschaulich, wie die Parameter ach XML serialisiert werde müsse: das Array mit de OIDs wird über die Value-Klasse serialisiert Ifo ud DeploymetWaitIfo sid eigee Klasse, die jeweils eie xml()-fuktio beihalte das Bemerkugsfeld (vom Typ Strig) wird hier direkt ausgegebe für das Datumsfeld wird die Value-Klasse verwedet Alle fehlerhafte bzw. fehlede Parameter werde durch xsi:il="true" repräsetiert. Sie köe im Prizip auch weggelasse werde, da Web-Services die Parameter über ihre Name idetifiziere VIP WebServices Programmierhadbuch 155

156 Kapitel 6 ud fehlede Parameter durch die Typ-spezifische Stadardwerte (False für Boolea, 0 für it ud log sowie ull für komplexe Type) ersetze. Das Eilese der Serveratwort muss sorgfältig erfolge. Es sid folgede Fehlerszearie dekbar: der Server atwortet gar icht die Atwort des Servers ethält kei XML die Atwort des Servers ethält keie SOAP-Evelope die Atwort des Servers ethält keie SOAP-Body die Atwort des Servers ethält eie Awedugsfehler Im Beispielprogramm werde geau diese Aspekte getestet. Der Rückgabewert der Fuktio submit(...) zeigt a, ob das Vorlege zur Qualitätssicherug erfolgreich durchgeführt wurde. Der Schwerpukt des ächste Beispiels ist die Deserialisierug der vom Web-Service gelieferte XML-Date. Aufruf eier Methode mit Rückgabewert Als Beispiel wird hier die Auswertug eies Filterausdrucks verwedet. VIP WebServices liefert als Ergebis ei Array vo ObjectData. Dieses Array besteht aus Eiträge, die ihre Ihalt über href="#id..." refereziere. I dem Beispiel werde XPath-Ausdrücke verwedet, um die etsprechede Elemete im DOM-Tree zu lokalisiere. ObjectData selber ist ei komplexer Datetyp, der uter aderem Elemete des Typs ObjectState, ObjectType, User, ArrayOfStrig ud ArrayOfObjectId refereziert. Diese sid auch wieder über href="#id..." eigebude. Zur Deserialisierug eies solche komplexe Objekts mittels eier eifache Programmiersprache gibt es mehrere Wege. Hier wird folgeder Asatz geutzt: 156 VIP WebServices Programmierhadbuch

157 Awedugsbeispiele 1. Die SOAP-Atwort wird i eie separate Parser gelade: resultdom.loadxml(reader.body.xml) 2. Dort wird das Attribut href im Elemet filterresult gesucht: result = 3. Aus dem Attribut wird der Wert der etsprechede ID extrahiert: resultid = Mid(result.text, 2) 4. ud damit das Array im DOM lokalisiert: List = resultdom.selectnodes("//*[@id='" & resultid & "']/*") 5. Für jede Eitrag i der Liste wird u ei ObjectData-Objekt agelegt: itemid = _ Mid(List.Item(i).Attributes.getNamedItem("href"). odevalue, 2) objectdataitem = resultdom.selectnodes("//*[@id='" &_ itemid & "']/*") results(i) = tmpobjectdata.getobjectfromnodelist(_ objectdataitem, resultdom) 6. Der Methode getobjectfromnodelist werde die eizele ObjectData-Attribute als eie IXMLDOMSelectio übergebe. Diese Elemete ethalte jeweils die Objekttyp-Iformatio (zum Beispiel <title xsi:type="xsd:strig"> PortalMaager-ger_v01</title>). Abhägig vom Typ wird u das etsprechede Attribut i ObjectData gesetzt. Komplexe Type wie zum Beispiel ObjectState verfüge jeweils über eie eigee Methode getobjectfromnodelist(...). VIP WebServices Programmierhadbuch 157

158 Kapitel 6 Hier folgt der Code der Methode filter(): ' ' filter: returs a array of ObjectData cotaiig the objects ' matchig the specified filter ad READ permissios for the ' autheticated user. The umber of records retured is passed ' via the referece variable umrows. ' Public Fuctio filter(byval myfilter As GeericFilter, _ ByVal startoid As ObjectID, _ ByRef sortlist() As Sort, _ ByVal startresult As Log, _ ByVal umberofresults As Log, _ ByRef attributekeys() As Strig, _ ByRef umrows As Iteger) As Variat iitialize_coectio umrows = 0 ' serialize request for filter serializer.startelemet "filter", VIP_NAMESPACE_URI ' Start elemet "filter" (xsi:type="vip:[equalfilter LessFilter...]) ' serializer.startelemet "filter" serializer.soapattribute "xsi:type",, "vip:" & myfilter.filtertype If Not myfilter Is Nothig The serializer.writexml myfilter.xml(serializer) Ed If serializer.edelemet ' Start elemet "startoid" ' serializer.startelemet "startoid" serializer.soapattribute "xsi:type",, "vip:objectid" If Not startoid Is Nothig The serializer.writexml startoid.xml Ed If serializer.edelemet ' Start elemet "sortlist" ' serializer.startelemet "sortlist" serializer.soapattribute "xsi:type",, "SOAP-ENC:Array" serializer.soapattribute "SOAP-ENC:arrayType",,_ "vip:sort[" & (UBoud(sortList) - LBoud(sortList)) & "]" Dim i As Iteger For i = LBoud(sortList) To UBoud(sortList) VIP WebServices Programmierhadbuch

159 Awedugsbeispiele serializer.startelemet "Item" serializer.soapattribute "xsi:type",, "vip:sort" serializer.writexml sortlist(i).xml serializer.edelemet Next i serializer.edelemet ' Start elemet "startresult" ' serializer.startelemet "startresult" serializer.soapattribute "xsi:type",, "xsd:it" serializer.writestrig startresult serializer.edelemet ' Start elemet "umberofresults" ' serializer.startelemet "umberofresults" serializer.soapattribute "xsi:type",, "xsd:it" serializer.writestrig umberofresults serializer.edelemet ' ' start attributekeys serializer.startelemet "attributekeys" serializer.soapattribute "xsi:type",, "SOAP-ENC:Array" serializer.soapattribute "SOAP-ENC:arrayType",, _ "xsd:strig[" & (UBoud(attributeKeys) -_ LBoud(attributeKeys)) & "]" For i = LBoud(attributeKeys) To UBoud(attributeKeys) - 1 serializer.startelemet "Item" serializer.soapattribute "xsi:type",, "xsd:strig" serializer.writexml attributekeys(i) serializer.edelemet Next i serializer.edelemet serializer.edelemet ' close SOAP-Body serializer.edbody ' close SOAP-Evelope serializer.edevelope ' sigal the ed of the SOAP message beig set to the server Coector.EdMessage ' create a ew SoapReader Dim Reader As New SoapReader ' load the XML from the Stream If Not Reader.Load(Coector.OutputStream) The Dim reaso As Strig VIP WebServices Programmierhadbuch 159

160 Kapitel 6 reaso = IIf(Reader.dom.parseError Is Nothig, _ "parser: ukow reaso", _ Reader.dom.parseError.reaso) MsgBox "filter failed:- " & reaso, vbexclamatio, "Error" Exit Fuctio Ed If ' if there is a fault use a message box to report it If Not Reader.Fault Is Nothig The MsgBox "filter failed:- " & _ Reader.faultstrig.odeTypedValue,_ vbexclamatio, "Error" Else ' get the retur Documet Dim resultdom As DOMDocumet30 Set resultdom = New DOMDocumet30 resultdom.setproperty "SelectioLaguage", "XPath" resultdom.asyc = False resultdom.validateoparse = False Dim success As Boolea ' set up the temporary results array Dim results() As objectdata If Reader.Body Is Nothig The success = False Else Let success = resultdom.loadxml(reader.body.xml) ' get the odelist of array items from the respose ' traverse to multiref with correspodig id Dim result As IXMLDOMNode Dim resultid As Strig ' look for correspodig attribute href=<xyy> Set result = resultdom.selectsiglenode(_ "//filterresult/@href") If Not result Is Nothig The resultid = result.text resultid = Mid(resultId, 2) Dim List, objectdataitemlist As IXMLDOMNodeList Set List = resultdom.selectnodes("//*[@id='"&resultid&"']/*") If List.Legth = 0 The 160 VIP WebServices Programmierhadbuch

161 Awedugsbeispiele Exit Fuctio Ed If ReDim results(list.legth - 1) umrows = List.Legth ' for each array elemet For i = 0 To (List.Legth - 1) ' Create Temporary "DocData" Dim tmpdocdata As New objectdata Dim itemid As Strig itemid =_ Mid(List.Item(i).Attributes.getNamedItem("href").odeValue, 2) Set objectdataitemlist =_ resultdom.selectnodes("//*[@id='" & itemid & "']/*") ' Populate the array elemet Set results(i) =_ tmpdocdata.getobjectfromnodelist(objectdataitemlist,_ resultdom) Next Ed If Ed If ' set the retur value filter = results Ed If Ed Fuctio Die Filter-Methode ka zum Beispiel folgedermaße agewedet werde: Sub vipfilterpdf() Dim filteresult As Variat If VipWebService Is Nothig The Set VipWebService = New VipWebServiceCliet Ed If Dim pdffilter As New GeericFilter Let pdffilter.filtertype = "EqualFilter" Set pdffilter.key = New Key Let pdffilter.key.strigvalue = "objecttype" Set pdffilter.value = New Value VIP WebServices Programmierhadbuch 161

162 Kapitel 6 Ed Sub Set pdffilter.value.objecttype = New objecttype Let pdffilter.value.objecttype.ame = "PDF" Dim startid As New objectid Let startid.id = "1" Dim datesort(1) As New Sort Let datesort(0).strigvalue = "createddate" Dim attributekeys(4) As Strig Let attributekeys(0) = "createddate" Let attributekeys(1) = "objectid" Let attributekeys(2) = "objectstate" Let attributekeys(3) = "title" Dim umrows As Iteger filterresult = VipWebService.filter(pdfFilter, startid, datesort, _ 0, 5, attributekeys, umrows) Mit diesem Beispiel werde die Code-Beispiele für Visual Basic beedet. De vollstädige Quellcode für die i Tabelle 55 Klassemodule auf Seite 150 aufgelistete Module fide Sie im Verzeichis \acs\webservices\vba\ im VIP-Istallatiosverzeichis. Diese Klasse köe Sie über Datei importiere i ei Visual Basic Projekt überehme. 6.2 C# ud ASP.NET Die Etwicklug Browser-basierter Beutzeroberfläche mit ASP.NET oder Stadard-Widows-Oberfläche mit Widows.Forms wird durch Visual Studio.NET sehr vereifacht. I diesem Kapitel erfahre Sie, wie Sie VIP WebServices i Visual Studio utze köe. 162 VIP WebServices Programmierhadbuch

163 Awedugsbeispiele Vorarbeite Richte Sie ei eues C#-Projekt ei, z.b. mit dem Name VipWebServiceCliet : Abb. 9 C#-Projekt eirichte Visual Studio erzeugt automatisch die beötigte Module für de Zugriff auf VIP WebServices, sobald Sie die URL der WSDL-Beschreibug als Webverweis (Im Meü Projects Add Web Referece) hizufüge: VIP WebServices Programmierhadbuch 163

164 Kapitel 6 Abb. 10 WSDL als Webverweis hizufüge Visual Studio lädt das WSDL i de like Bereich dieses Festers ud verlagt da och eimal Beutzerame ud Passwort: 164 VIP WebServices Programmierhadbuch

165 Awedugsbeispiele Abb. 11 Beutzerkeug ud Passwort eigebe Nach erfolgreicher Autorisierug köe Sie de Dialog Add Web Referece abschließe, idem Sie auf Add Referece klicke. Visual Studio erzeugt aus der WSDL-Beschreibug vo VIP WebServices ei Modul im Namesraum (Namespace) VipWebServiceCliet.com.compay.vipserver. Dort fide Sie für jede im VIP WebServices beötigte Datetyp eie Klasse. Der Object Browser gibt eie gute Überblick über die automatisch erzeugte Klasse: VIP WebServices Programmierhadbuch 165

166 Kapitel 6 Abb. 12 Automatisch erzeugte Klasse im Namesraum VipWebServiceCliet Sie köe u mit der Nutzug vo VIP WebServices begie. Als Beispiel wird im Folgede eie ASP.NET-Seite (default.aspx) verwedet, die i eier Tabelle alle PDF-Dateie der Website Iteret- Site auflistet. Jede Zeile der Tabelle ethält ei Kästche zur Auswahl der Zeile. Alle ausgewählte Objekte lasse sich über eie Schaltfläche vorlege bzw. freigebe. 166 VIP WebServices Programmierhadbuch