Skip navigation links

oracle.wcps.property
Class PropertyServiceContext.Builder

java.lang.Object
oracle.wcps.property.PropertyServiceContext.Builder

Enclosing class:

PropertyServiceContext

public static class PropertyServiceContext.Builder

extends java.lang.Object

A builder class to create an instance of IContext.

Constructor Summary

PropertyServiceContext.Builder()

Method Summary

IContext	build() Returns the initialized PropertyServiceContext instance.
PropertyServiceContext.Builder	withAcceptHeader(java.lang.String value) Sets the accept HTTP request header property with the given value.
PropertyServiceContext.Builder	withContentTypeHeader(java.lang.String value) Sets the content-type HTTP request header property with the given value.
PropertyServiceContext.Builder	withHttpServletRequest(java.lang.Object req) Sets the HttpServletRequest property with the given value req.
PropertyServiceContext.Builder	withHttpServletResponse(java.lang.Object res) Sets the HttpServletResponse property with the given value res.
PropertyServiceContext.Builder	withPassword(java.lang.String password) Sets the password property with the given password.
PropertyServiceContext.Builder	withUri(java.lang.String uri) Sets the property service rest API's base URI as URI property.
PropertyServiceContext.Builder	withUserName(java.lang.String userName) Sets the username property with the given userName.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyServiceContext.Builder

public PropertyServiceContext.Builder()

Method Detail

withUri

public PropertyServiceContext.Builder withUri(java.lang.String uri)

Sets the property service rest API's base URI as URI property. This is a required property for remote access of the property service API.

Parameters:

uri - the property service rest API's base URI.

Returns:

this builder.

withUserName

public PropertyServiceContext.Builder withUserName(java.lang.String userName)

Sets the username property with the given userName. This is a required property for remote access of the property service API. This is used for authentication.

Parameters:

userName - a valid username to authenticate and access the property service rest API.

Returns:

this builder.

withPassword

public PropertyServiceContext.Builder withPassword(java.lang.String password)

Sets the password property with the given password. This is a required property for remote access of property service API. This is used for authentication.

Parameters:

password - a valid password for the username property that can be used for authentication.

Returns:

this builder.

withAcceptHeader

public PropertyServiceContext.Builder withAcceptHeader(java.lang.String value)

Sets the accept HTTP request header property with the given value. By default the accept header is set to "application/xml". The other supported value is "application/json".

Parameters:

value - the accept request header's value.

Returns:

this builder.

withContentTypeHeader

public PropertyServiceContext.Builder withContentTypeHeader(java.lang.String value)

Sets the content-type HTTP request header property with the given value. By default the content-type header is set to "application/xml". The other supported value is "application/json".

Parameters:

value - the content-type request header's value.

Returns:

this builder.

withHttpServletRequest

public PropertyServiceContext.Builder withHttpServletRequest(java.lang.Object req)

Sets the HttpServletRequest property with the given value req. This property is used when configured locators need to use it to check the currently authenticated subject and login to backend systems that locators are accessing.

Parameters:

req - an http servlet request.

Returns:

this builder.

withHttpServletResponse

public PropertyServiceContext.Builder withHttpServletResponse(java.lang.Object res)

Sets the HttpServletResponse property with the given value res.

Parameters:

res - an http servlet response.

Returns:

this builder.

build

public IContext build()

Returns the initialized PropertyServiceContext instance.

Returns:

a property service context instance.

Skip navigation links