From 4bb05ad02a82ee63aa14cab928c254ad0f8f5989 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Ale=C5=A1=20K=C5=99enek?= Date: Wed, 29 Jun 2005 09:01:16 +0000 Subject: [PATCH] HTML documentation --- org.glite.jp.ws-interface/Makefile | 7 + org.glite.jp.ws-interface/src/JobProvenancePS.xml | 97 +++++++++---- .../src/JobProvenanceTypes.xml | 18 ++- org.glite.jp.ws-interface/src/doc.xml | 2 + org.glite.jp.ws-interface/src/puke-ug.xsl | 156 +++++++++++++++++++++ 5 files changed, 243 insertions(+), 37 deletions(-) create mode 100644 org.glite.jp.ws-interface/src/doc.xml create mode 100644 org.glite.jp.ws-interface/src/puke-ug.xsl diff --git a/org.glite.jp.ws-interface/Makefile b/org.glite.jp.ws-interface/Makefile index 595f7ea..ee80ab4 100644 --- a/org.glite.jp.ws-interface/Makefile +++ b/org.glite.jp.ws-interface/Makefile @@ -15,6 +15,8 @@ VPATH=${top_srcdir}/interface:${top_srcdir}/src STAGETO=interface XSLTPROC=xsltproc +XMLLINT:=xmllint +docbookxls:=http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl #WSDL=JobProvenancePS.wsdl JobProvenanceIS.wsdl JobProvenanceTypes.wsdl WSDL=JobProvenancePS.wsdl JobProvenanceTypes.wsdl @@ -52,3 +54,8 @@ clean: %.wsdl: %.xml ${XSLTPROC} ../src/puke-wsdl.xsl $< >$@ + +JobProvenancePS.html: doc.xml JobProvenancePS.xml JobProvenanceTypes.xml puke-ug.xsl + ${XSLTPROC} --novalid ../src/puke-ug.xsl $< >doc-html.xml + ${XMLLINT} --valid --noout doc-html.xml + ${XSLTPROC} --stringparam chapter.autolabel 0 ${docbookxls} doc-html.xml >$@ diff --git a/org.glite.jp.ws-interface/src/JobProvenancePS.xml b/org.glite.jp.ws-interface/src/JobProvenancePS.xml index 0a5f921..3d7b0e7 100644 --- a/org.glite.jp.ws-interface/src/JobProvenancePS.xml +++ b/org.glite.jp.ws-interface/src/JobProvenancePS.xml @@ -7,60 +7,97 @@ elemPrefix="jpe" xmlns:jpt="http://glite.org/wsdl/types/jp"> + CVS revision: + + + + The Job Provenance (JP) Primary Storage Service is responsible + to keep the JP data + (definition of submitted jobs, execution conditions and environment, + and important points of the job life cycle) in a compact and + economic form. + + + + The JP Primary storage, as described in section 8.4 of + the + + Architecture deliverable DJRA1.1 + + provides public interfaces for data storing, + retrieval based on basic metadata, and registration of Index servers for + incremental feed. + + + + Command interface to JP is completely covered by the WS interface covered here. + Bulk file transfers are done via specialised protocols, currently gsiftp only. + + + - - - + Register job with the JP primary storage. + Jobid of the registered job. + Owner of the job (DN of X509 certificate). + Any error. - - - - - - - - + Start uploading a file. + Jobid to which this file is related. + + Type of the file (URI). The server must have a plugin handing this type. + + Name of the file (used to distinguish among more files of the same type). + The client promisses to finish the upload before this time. + MIME type of the file. + URL where the client should upload the file. + Server's view on when the upload must be finished. + Any error. - - + Confirm a successfully finished file apload. + Destination URL returned by StartUpload before. + Any error. - - - + Record an additional user tag. + Job to which the tag is added. + Name and value of the tag. + Any error. - - - - - - - - + Request for feeding a JP Index server (issued by this server). + Endpoint of the listening index server. + Which attributes of jobs is the index server interested in. + Which jobs is the server interested in. + Data on jobs stored at PS in the past are required. + Data on jobs that will arrive in future are required. + Unique ID of the created feed session. + When the session expires. + Any error. - - - + Refresh an existing feed session. + Existing feed session ID to be refreshed. + New session expiration time. + Any error. - - - + Return URL's of files for a given single job. + The job. + List of the stored files. + Any error. diff --git a/org.glite.jp.ws-interface/src/JobProvenanceTypes.xml b/org.glite.jp.ws-interface/src/JobProvenanceTypes.xml index ebbede4..e04a4e7 100644 --- a/org.glite.jp.ws-interface/src/JobProvenanceTypes.xml +++ b/org.glite.jp.ws-interface/src/JobProvenanceTypes.xml @@ -4,22 +4,26 @@ ns="http://glite.org/wsdl/services/jp" typePrefix="jpt"> + CVS revision: + + Operators used in queries. Most are self-explanatory. - + The attribute is between two specified values. - - - - - + A single value for a user tag. + Name of the tag. + Sequence of this value (if there are more occurences of this tag it may be used to order them. + When the tag was created. + Value - printable string. + Value - binary. @@ -27,7 +31,7 @@ - + diff --git a/org.glite.jp.ws-interface/src/doc.xml b/org.glite.jp.ws-interface/src/doc.xml new file mode 100644 index 0000000..78cb6a5 --- /dev/null +++ b/org.glite.jp.ws-interface/src/doc.xml @@ -0,0 +1,2 @@ + + diff --git a/org.glite.jp.ws-interface/src/puke-ug.xsl b/org.glite.jp.ws-interface/src/puke-ug.xsl new file mode 100644 index 0000000..ff70ccf --- /dev/null +++ b/org.glite.jp.ws-interface/src/puke-ug.xsl @@ -0,0 +1,156 @@ + + + + + + + + + + + <xsl:value-of select="document('JobProvenancePS.xml')/service/@name"/> + + + Overview + + + + + Operations + + + + + + + + + Types + + + + + + + + + + + + + list of + + + + + + + + + + + + + + + + + + + <xsl:value-of select="@name"/> + + + Inputs: + + + + + + + N/A + + + + Outputs: + + + + + + + N/A + + + + + + + + + + <xsl:value-of select="@name"/> + + + + Structure (sequence complex type in WSDL) + Fields: ( type name description ) + + + Union (choice complex type in WSDL) + Fields: ( type name description ) + + + Enumeration (restriction of xsd:string in WSDL), + exactly one of the values must be specified. + + Values: + + + Flags (sequence of restricted xsd:string in WSDL), + any number of values can be specified together. + + Values: + + + + + + + + + list of + + + + + + + + + + + + + + + + + + + + (optional) + + + + + + + + + + + + + -- 1.8.2.3