Java Doc for HTTPHeaders.java in » Content-Management-System » harmonise » com » ibm » webdav » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Content Management System » harmonise » com.ibm.webdav

Source Cross Reference Class Diagram Java Document (Java Doc)

java.util .Properties

com.ibm.webdav .HTTPHeaders

HTTPHeaders

public class HTTPHeaders extends Properties (Code)

A HTTPHeaders represents additional information about the resource that may effect how a method is executed, or reflect information that is returned from a method execution. These methods correspond to the HTTP/1.1 and WebDAV request and response Headers. Method names correspond to the Header names after suitable translation to Java syntax. Not all HTTP/1.1 headers are included, but all headers are supported through the get and put methods. The method descriptions are brief. For further details, see the HTTP/1.1 specification, section 14, and the WebDAV specification, section 9.

Values for the request context are set before calling a method of Resource or Collection, and provide additional parameters for the method or context in which it is executed. After the method returns, additional information about the method execution is available in the context.

Many of these headers are only used internally by the ResourceHTTPImpl class to marshall arguments between the client and server using the HTTP protocol. Most of this information can be more conveniently obtained through the parameters and return values of class Resource.

Since header names are case insensitive, all headers are converted to lower case before being used to search for context information.
author:
Jim Amsden <jamsden@us.ibm.com>

Field Summary
static BASE64Decoder	base64decoder
static BASE64Encoder	base64encoder
public static HTTPHeaders	defaults

Constructor Summary
public	HTTPHeaders() The default constructor for a ResourceContext.
public	HTTPHeaders(HTTPHeaders defaults) Construct a HTTPHeaders instance with a set of default values.

Method Summary
public String	DAV() Get the DAV level supported by the server.
public void	DAV(String value) Set the DAV level supported by the server.
public String	accept() Get what media types are acceptable for a response.
public void	accept(String value) Set what media types are acceptable for a response.
public String	acceptCharset() Get what character sets are acceptable for a response.
public void	acceptCharset(String value) Set what character sets are acceptable for a response.
public String	acceptEncoding() Get what content-encoding values are acceptable for a response.
public void	acceptEncoding(String value) Get what content-encoding values are acceptable for a response.
public String	acceptLanguage() Get what natural languages are acceptable for a response.
public void	acceptLanguage(String value) Set what natural languages are acceptable for a response.
public String	acceptRanges() Get the range requests acceptable to a server.
public void	acceptRanges(String value) Set the range requests acceptable to a server.
public String	age() Get the sender's estimate of the time since the response was generated.
public void	age(String value) Set the sender's estimate of the time since the response was generated.
public String	allow()
public void	allow(String value)
public String	authorization() Get the user's credentials for the realm of the resource being requested.
public void	authorization(String value) Set the user's credentials for the realm of the resource being requested.
public String	cacheControl() Get the cache control directives that must be obeyed.
public void	cacheControl(String value) Set the cache control directives that must be obeyed.
public String	connection() Get sender connection options.
public void	connection(String value) Set sender connection options.
public boolean	containsKey(Object keyi) See if the resource context contains a value for a given key.
public String	contentEncoding() Get what additional content encodings have been applied to the entity body.
public void	contentEncoding(String value) Set what additional content encodings have been applied to the entity body.
public String	contentLanguage() Get the natural language of the intended audience for the entity body.
public void	contentLanguage(String value) Set the natural language of the intended audience for the entity body.
public long	contentLength() Get the content length in bytes of the entity body.
public void	contentLength(long value) Set the content length in bytes of the entity body.
public String	contentLocation() Get the resource location for the response.
public void	contentLocation(String value) Set the resource location for the response.
public String	contentType() Get the MIME type for the response contents.
public void	contentType(String value) Set the MIME type for the response contents.
public String	date() The date the request was made.
public void	date(String value) Set the date the request was made.
public String	depth() Get the depth to apply to resource collections.
public void	depth(String value) Set the depth to be applied to resource collections.
public String	destination() Get the destination URL for a copy or move operation.
public void	destination(String value) Set the destination URL for a copy or move operation.
public String	etag() Get the entity tag for the associated entity.
public void	etag(String value) Set the entity tag for the associated entity.
public String	expires() Get the date/time after which the response should be considered stale.
public void	expires(String value) Set the date/time after which the response should be considered stale.
public Object	get(Object keyi) Get the value of an entry in the resource context.
public String	getAuthorizationId() Get the user agent or principal's identifier from the authorication context.
public String	getPassword() Get the user agent or principal's password from the authorication context.
public int	getTimeout() Get the lock timeout value.
public String	host() Get the Internet host and port of the resource being requested.
public void	host(String value) Set the Internet host and port of the resource being requested.
public String	lastModified() Get when the resource was last modified.
public void	lastModified(String value) Set when the resource was last modified.
public String	location() Get the redirect location.
public void	location(String value) Set the redirect location.
public String	lockToken() Get the lock token for the resource.
public void	lockToken(String value) Set the lock token for the resource.
public String	overwrite() Get if copy or move should overwrite an existing destination.
public void	overwrite(String value) Set if copy or move should overwrite an existing destination.
public Precondition	precondition() Get any precondition that must be true in order for method execution to be successful.
public void	precondition(Precondition value) Set any precondition that must be true in order for method execution to be successful.
public void	precondition(String value) Set any precondition that must be true in order for method execution to be successful.
public Object	put(Object keyi, Object value) Set the value of a resource context.
public String	referer() Get the URI of the resource from which the request was obtained.
public void	referer(String value) Set the URI of the resource from which the request was obtained.
public Object	remove(Object keyi) Remove an entry from the resource context.
public String	server() Get information about the software used by the origin server to handle the request.
public void	server(String value) Set information about the software used by the origin server to handle the request.
public void	setBasicAuthorization(String userid, String password) Set the authorization context using the Basic authentication scheme.
public void	setTimeout(int value) Set the lock timeout value.
public String	statusURI() Get the URI of the resource whose method is in process.
public void	statusURI(String value) Set the URI of the resource whose method is in process.
public String	timeout() Get the lock timeout value.
public void	timeout(String value) Set the lock timeout value.
public String	userAgent() Get information about the user agent originating the request.
public void	userAgent(String value) Set information about the user agent originating the request.

Field Detail

base64decoder
static BASE64Decoder base64decoder(Code)

base64encoder
static BASE64Encoder base64encoder(Code)

defaults
public static HTTPHeaders defaults(Code)

Constructor Detail

HTTPHeaders
public HTTPHeaders()(Code)
	The default constructor for a ResourceContext.

HTTPHeaders
public HTTPHeaders(HTTPHeaders defaults)(Code)
	Construct a HTTPHeaders instance with a set of default values. Parameters: defaults - default values for the new resource context

Method Detail

DAV
public String DAV()(Code)
	Get the DAV level supported by the server.

DAV
public void DAV(String value)(Code)
	Set the DAV level supported by the server.

accept
public String accept()(Code)
	Get what media types are acceptable for a response.

accept
public void accept(String value)(Code)
	Set what media types are acceptable for a response.

acceptCharset
public String acceptCharset()(Code)
	Get what character sets are acceptable for a response.

acceptCharset
public void acceptCharset(String value)(Code)
	Set what character sets are acceptable for a response.

acceptEncoding
public String acceptEncoding()(Code)
	Get what content-encoding values are acceptable for a response.

acceptEncoding
public void acceptEncoding(String value)(Code)
	Get what content-encoding values are acceptable for a response.

acceptLanguage
public String acceptLanguage()(Code)
	Get what natural languages are acceptable for a response.

acceptLanguage
public void acceptLanguage(String value)(Code)
	Set what natural languages are acceptable for a response.

acceptRanges
public String acceptRanges()(Code)
	Get the range requests acceptable to a server.

acceptRanges
public void acceptRanges(String value)(Code)
	Set the range requests acceptable to a server.

age
public String age()(Code)
	Get the sender's estimate of the time since the response was generated.

age
public void age(String value)(Code)
	Set the sender's estimate of the time since the response was generated.

allow
public String allow()(Code)
	Get methods allowed on a resource

allow
public void allow(String value)(Code)
	Set methods allowed on a resource

authorization
public String authorization()(Code)
	Get the user's credentials for the realm of the resource being requested.

authorization
public void authorization(String value)(Code)
	Set the user's credentials for the realm of the resource being requested. See Also: com.ibm.webdav.ResourceContext.setBasicAuthorization

cacheControl
public String cacheControl()(Code)
	Get the cache control directives that must be obeyed.

cacheControl
public void cacheControl(String value)(Code)
	Set the cache control directives that must be obeyed.

connection
public String connection()(Code)
	Get sender connection options.

connection
public void connection(String value)(Code)
	Set sender connection options.

containsKey
public boolean containsKey(Object keyi) throws IllegalArgumentException(Code)
	See if the resource context contains a value for a given key. Keys are case insensitive. Parameters: keyi - the name of the value to check for true if the context contains a value for the key exception: IllegalArgumentException - thrown if keyi is not a String

contentEncoding
public String contentEncoding()(Code)
	Get what additional content encodings have been applied to the entity body.

contentEncoding
public void contentEncoding(String value)(Code)
	Set what additional content encodings have been applied to the entity body.

contentLanguage
public String contentLanguage()(Code)
	Get the natural language of the intended audience for the entity body.

contentLanguage
public void contentLanguage(String value)(Code)
	Set the natural language of the intended audience for the entity body.

contentLength
public long contentLength()(Code)
	Get the content length in bytes of the entity body.

contentLength
public void contentLength(long value)(Code)
	Set the content length in bytes of the entity body.

contentLocation
public String contentLocation()(Code)
	Get the resource location for the response.

contentLocation
public void contentLocation(String value)(Code)
	Set the resource location for the response.

contentType
public String contentType()(Code)
	Get the MIME type for the response contents. the Content-Type header

contentType
public void contentType(String value)(Code)
	Set the MIME type for the response contents. Parameters: value - the MIME Content-Type

date
public String date()(Code)
	The date the request was made. the Date header

date
public void date(String value)(Code)
	Set the date the request was made.

depth
public String depth()(Code)
	Get the depth to apply to resource collections.

depth
public void depth(String value)(Code)
	Set the depth to be applied to resource collections.

destination
public String destination()(Code)
	Get the destination URL for a copy or move operation.

destination
public void destination(String value)(Code)
	Set the destination URL for a copy or move operation.

etag
public String etag()(Code)
	Get the entity tag for the associated entity.

etag
public void etag(String value)(Code)
	Set the entity tag for the associated entity.

expires
public String expires()(Code)
	Get the date/time after which the response should be considered stale.

expires
public void expires(String value)(Code)
	Set the date/time after which the response should be considered stale.

get
public Object get(Object keyi)(Code)
	Get the value of an entry in the resource context. Keys are case insensitive. Parameters: keyi - the name of the value to get exception: IllegalArgumentException - thrown if keyi is not a String

getAuthorizationId
public String getAuthorizationId()(Code)
	Get the user agent or principal's identifier from the authorication context. the user agent's identifier

getPassword
public String getPassword()(Code)
	Get the user agent or principal's password from the authorication context. the user agent's password

getTimeout
public int getTimeout()(Code)
	Get the lock timeout value. The lock is a candidate for timeing out after this nunber of seconds has elapsed. the lock timeout value in seconds. -1 means infinite timeout.

host
public String host()(Code)
	Get the Internet host and port of the resource being requested.

host
public void host(String value)(Code)
	Set the Internet host and port of the resource being requested.

lastModified
public String lastModified()(Code)
	Get when the resource was last modified.

lastModified
public void lastModified(String value)(Code)
	Set when the resource was last modified.

location
public String location()(Code)
	Get the redirect location.

location
public void location(String value)(Code)
	Set the redirect location.

lockToken
public String lockToken()(Code)
	Get the lock token for the resource. the lock token (not the coded URL returned in the HTTP Lock-Token header)

lockToken
public void lockToken(String value)(Code)
	Set the lock token for the resource. This context item must be set before invoking any method on a locked resource that changes the state of the resource. Parameters: value - the locktoken (not the coded URL in the HTTP Lock-Token header)

overwrite
public String overwrite()(Code)
	Get if copy or move should overwrite an existing destination. "T" if overwrite is true

overwrite
public void overwrite(String value)(Code)
	Set if copy or move should overwrite an existing destination. Parameters: value - "T" if overwrite is true, "F" for false

precondition
public Precondition precondition() throws WebDAVException(Code)
	Get any precondition that must be true in order for method execution to be successful. A precondition corresponds to the WebDAV "If" header.

precondition
public void precondition(Precondition value)(Code)
	Set any precondition that must be true in order for method execution to be successful. A precondition corresponds to the WebDAV "If" header.

precondition
public void precondition(String value)(Code)
	Set any precondition that must be true in order for method execution to be successful. A precondition corresponds to the WebDAV "If" header.

put
public Object put(Object keyi, Object value)(Code)
	Set the value of a resource context. Keys are case insensitive. Parameters: keyi - the name of the value Parameters: value - the value to set

referer
public String referer()(Code)
	Get the URI of the resource from which the request was obtained.

referer
public void referer(String value)(Code)
	Set the URI of the resource from which the request was obtained.

remove
public Object remove(Object keyi)(Code)
	Remove an entry from the resource context. Keys are case insensitive. Parameters: keyi - the name of the entry to remove the object removed

server
public String server()(Code)
	Get information about the software used by the origin server to handle the request.

server
public void server(String value)(Code)
	Set information about the software used by the origin server to handle the request.

setBasicAuthorization
public void setBasicAuthorization(String userid, String password)(Code)
	Set the authorization context using the Basic authentication scheme. Parameters: userid - the authorization id of the user agent or principal Parameters: password - the user agent's password

setTimeout
public void setTimeout(int value)(Code)
	Set the lock timeout value. The lock is a candidate for timeing out after this nunber of seconds has elapsed. Parameters: value - the lock timeout value in seconds. -1 means infinite timeout.

statusURI
public String statusURI()(Code)
	Get the URI of the resource whose method is in process.

statusURI
public void statusURI(String value)(Code)
	Set the URI of the resource whose method is in process.

timeout
public String timeout()(Code)
	Get the lock timeout value.

timeout
public void timeout(String value)(Code)
	Set the lock timeout value.

userAgent
public String userAgent()(Code)
	Get information about the user agent originating the request.

userAgent
public void userAgent(String value)(Code)
	Set information about the user agent originating the request.

Fields inherited from java.util.Properties

protected Properties defaults(Code)(Java Doc)

Methods inherited from java.util.Properties

public String getProperty(String key)(Code)(Java Doc)
public String getProperty(String key, String defaultValue)(Code)(Java Doc)
public void list(PrintStream out)(Code)(Java Doc)
public void list(PrintWriter out)(Code)(Java Doc)
public synchronized void load(Reader reader) throws IOException(Code)(Java Doc)
public synchronized void load(InputStream inStream) throws IOException(Code)(Java Doc)
public synchronized void loadFromXML(InputStream in) throws IOException, InvalidPropertiesFormatException(Code)(Java Doc)
public Enumeration propertyNames()(Code)(Java Doc)
public synchronized void save(OutputStream out, String comments)(Code)(Java Doc)
public synchronized Object setProperty(String key, String value)(Code)(Java Doc)
public void store(Writer writer, String comments) throws IOException(Code)(Java Doc)
public void store(OutputStream out, String comments) throws IOException(Code)(Java Doc)
public synchronized void storeToXML(OutputStream os, String comment) throws IOException(Code)(Java Doc)
public synchronized void storeToXML(OutputStream os, String comment, String encoding) throws IOException(Code)(Java Doc)
public Set<String> stringPropertyNames()(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.