demo-content.document-transform-demo.Fedora-API-A.wsdl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fcrepo-client Show documentation
The Fedora Client is a Java Library that allows API access to a Fedora Repository. The client is typically one part of a full Fedora installation.
The newest version!


	
	
		
			
			
			
			
			
			
			
			
			
			
		
	
	
		
			the PID of the object.
		
		
			the date/time stamp specifying the desired view of the 
				object.  If null, the current view of the object (the most recent time) 
				is assumed.
			
		
	
	
		
			A data structure that contains key metadata
				about the object, including URLs to view the Dissemination
				Index and the Item Index for the object.
			
		
	
	
		
			the PID of the object.
		
		
			the date/time stamp specifying the desired view of the 
			      object.  If null, the current view of the object (the most recent time) 
			      is assumed.
			
		
	
	
		
			A set of method definitions that represent 
				all possible disseminations that can be run on the object.
			
		
	
	
		
			the PID of the object.
		
		
			the PID of the behavior definition.
		
		
			the name of the method to invoke.
		
		
			a set of name-value pairs that act as parameters to the method.
		
		
			the date/time stamp specifying the desired view of the 
				object.  If null, the current view of the object (the most recent time) 
				is assumed.
			
		
	
	
		
			the desired view of the object as a mime-typed stream.
		
	
	
		
			the PID of the object.
		
		
			the date/time stamp specifying the desired view of the 
				object.  If null, the current view of the object (the most recent time)
				is assumed.
			
		
	
	
		
			the PIDs of the behavior definitions, in no particular order.
		
	
	
		
			the PID of the object.
		
		
			the PID of the behavior definition.
		
		
			the date/time stamp specifying the desired view of the 
			object.  If null, the current view of the object (the most recent time) 
			is assumed.
			
		
	
	
		
			pre-bound WSDL that the client may use to formulate 
			dissemination requests for the given digital object and behavior 
			definition.
			
		
	
	
		
			the PID of the object.
		
		
			the PID of the behavior definition.
		
		
			the date/time stamp specifying the desired view of the 
			object.  If null, the current view of the object (the most recent time) 
			is assumed.
		
		
	
	
		
			pre-bound WSDL that the client may use to formulate 
				dissemination requests for the given digital object and behavior 
				definition.
			
		
	
	
		
			an array of unique object fields
            from fedora-types:ObjectFields.  This tells the server which fields
            should be returned from the query.
		
		
			the maximum number of results that the server should
                provide at once.  This may be null, in which case the server
                will return the maximum number of results it has been configured
                to return.
		
		
			the terms or conditions for the search.
		
	
	
		
			containing an array of ObjectFields and, possibly,
            a listSession.
		
	
	
		
			the token of the session in which the next few
                results can be found.
		
    
	
		The Fedora Access service defines an open interface for
		    accessing digital objects.  The access operations include methods to do
		    reflection on a digital object (i.e., to discover the kinds of
		    disseminations that are available on the object), and to request
		    disseminations.  The major function of the Fedora Access service is 
		    to fulfill a client's request for dissemination.  To support disseminations,
		    the underlying repository system must evaluate the behavior associations
		    specified in a digital object, and figure out how to dispatch a service
		    request to a supporting service with which the digital object associates.
		    The supporting service may be internal to the repository system, or it may
		    be an external web service that the repository must call upon.  The
		    underlying repostitory system facilitates all external service bindings
		    on behalf of the client, simply returning a dissemination result via the
		    Access service layer.
		
		
			Gets a profile of the object which includes key
				metadata fields and URLs for the object Dissemination 
				Index and the object Item Index.  Can be thought of as a
				default view of the object.
			
			
			
		
		
			Inquires upon all object Disseminators to obtain Behavior Definition PIDs,
				and methodNames supported by a digital object.  This returns a set of method definitions
				that represent all possible disseminations that can be run on the object.
			
			
			
		
		
			Gets a MIME-typed view of a digital object,
				given the behavior definition id, a behavior method name, and any behavior 
				method parameters.	Information about behavior method names and parameters is
				obtained via other APA-A operations	(see getObjectMethods,	getBehaviorMethods,
				and getBehaviorMethodsXML). The getDissemination operation essentially
				encapsulates another operation (a behavior method on the Fedora object). 
				The getDissemination operation hides from the client the details of
				how a behavior method is fulfilled (i.e., what behavior mechanism 
				performs the work, and how the request is invoked upon the behavior
				mechanism).
			
			
			
		
		
			Gets a list of behavior definitions supported by a
				digital object.  This is a set of PIDs, one for each behavior
				definition type associated with the object's disseminator(s).
			
			
			
		
		
			Gets a list of the method descriptions for a given
      			behavior definition type associated with the digital object.
      		
			
			
		
		
			Gets a list of the method descriptions for a given
      			behavior definition type associated with the digital object.
      		
			
			
		
		
			Gets the requested ObjectFields on all objects in the
                repository matching the given criteria.
			
			
			
		
		
			Gets the next list of results from a truncated
                findObjects response.
			
			
			
		
	
	
		
		
			
			
				
			
			
				
			
		
		
			
			
				
			
			
				
			
		
		
			
			
				
					Inside the 'parameters' input message, 
				          mechanism-specific parameters may be given.  When given as an HTTP 
				          GET API-A request to Fedora, the mechanism-specific parameters are to 
				          be further encoded in the HTTP GET request in the value of the 
				          'parameters' message.  When demarshaling the request, the Fedora 
				          server will un-URL-encode the the value of 'parameters', and pass the 
				          provided value(s) to the underlying service.