com.wewebu.ow.server.ecmimpl.cmis.wshandler
Interface OwCMISSecurityHandlerInterface

All Superinterfaces:

Handler<SOAPMessageContext>, SOAPHandler<SOAPMessageContext>

All Known Implementing Classes:

OwCMISSecurityHandler

public interface OwCMISSecurityHandlerInterface
extends SOAPHandler<SOAPMessageContext>

Extended Security Handler interface for web service communication.
This Interface extends the SOAPHandler<SOAPMessageContex> interface to provide additional information for the W3C definition of WS-i18n extension.

Keep in mind that the implementing class must have a default constructor.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Since:

3.1.0.0

Field Summary

static String	PWD password key for init map
static String	USER User name key for init map
static String	WS_I18N URI for the international support in web services
static String	WS_I18N_PREFIX prefix for internationalization: i18n
static String	WS_SECEXT URI of the web service security extension
static String	WS_SECEXT_PREFIX prefix for security extension: wsse
static String	WS_SECUTILITY URI of the web service security utility
static String	WS_SECUTILITY_PREFIX prefix for security utility: wsu
static String	WS_USER_TOKEN_PROFILE URI of the web service security user name token profile 1.0

Method Summary

Locale	getLocale() Return the defined Locale which should be used by for the SOAP WS-i18n header.
String	getTimezoneString() Deprecated. since 4.0.0.0 use getWsi18nTimeZone() instead
String	getWsi18nTimeZone() Return the Time zone String which should be used in web services header.
void	init(Map<String,String> arr_p) Initial method which is called after instantiation of the Security handler.
void	setLocale(Locale locale_p) Set the Locale which should be provided for WS-i18n localization.
void	setTimezoneString(String timeZone_p) Deprecated. since 4.0.0.0 use setWsi18nTimeZone(TimeZone) or setWsi18nTimeZone(String) instead
void	setWsi18nTimeZone(String timeZone_p) Set the String which should represent the value of the time zone web service header.
void	setWsi18nTimeZone(TimeZone timeZone_p) Transform the provided Timezone into a string which should be used for WSI communication with CMIS system.

Methods inherited from interface javax.xml.ws.handler.soap.SOAPHandler

getHeaders

Methods inherited from interface javax.xml.ws.handler.Handler

close, handleFault, handleMessage

Field Detail

USER

static final String USER

User name key for init map

See Also:

Constant Field Values

PWD

static final String PWD

password key for init map

See Also:

Constant Field Values

WS_SECEXT

static final String WS_SECEXT

URI of the web service security extension

See Also:

Constant Field Values

WS_SECUTILITY

static final String WS_SECUTILITY

URI of the web service security utility

See Also:

Constant Field Values

WS_USER_TOKEN_PROFILE

static final String WS_USER_TOKEN_PROFILE

URI of the web service security user name token profile 1.0

See Also:

Constant Field Values

WS_I18N

static final String WS_I18N

URI for the international support in web services

See Also:

Constant Field Values

WS_SECEXT_PREFIX

static final String WS_SECEXT_PREFIX

prefix for security extension: wsse

See Also:

Constant Field Values

WS_SECUTILITY_PREFIX

static final String WS_SECUTILITY_PREFIX

prefix for security utility: wsu

See Also:

Constant Field Values

WS_I18N_PREFIX

static final String WS_I18N_PREFIX

prefix for internationalization: i18n

See Also:

Constant Field Values

Method Detail

setLocale

void setLocale(Locale locale_p)

Set the Locale which should be provided for WS-i18n localization. Remember that the locale should be used with the LDML definitions if added to the SOAP header.

Parameters:

locale_p - Locale to be used, or null

getLocale

Locale getLocale()

Return the defined Locale which should be used by for the SOAP WS-i18n header. Can return null to avoid the attaching/creation of the web service localization header.

Returns:

Locale or null

setTimezoneString

@Deprecated
void setTimezoneString(String timeZone_p)

Deprecated. since 4.0.0.0 use setWsi18nTimeZone(TimeZone) or setWsi18nTimeZone(String) instead

Set the String which should represent the value of the time zone web service header. The String should be regarding the W3C definition of WS-i18n specification.

deprecated since 4.0.0.0 use setWsi18nTimeZone(TimeZone) or setWsi18nTimeZone(String) instead

Parameters:

timeZone_p - String can be null.

setWsi18nTimeZone

void setWsi18nTimeZone(TimeZone timeZone_p)

Transform the provided Timezone into a string which should be used for WSI communication with CMIS system.

Parameters:

timeZone_p - TimeZone can be null.

Since:

4.0.0.0

See Also:

setWsi18nTimeZone(String)

setWsi18nTimeZone

void setWsi18nTimeZone(String timeZone_p)

Set the String which should represent the value of the time zone web service header. The String should be regarding the W3C definition of WS-i18n specification.

Parameters:

timeZone_p - String can be null.

Since:

4.0.0.0

getTimezoneString

@Deprecated
String getTimezoneString()

Deprecated. since 4.0.0.0 use getWsi18nTimeZone() instead

Return the Time zone String which should be used in web services header. Can return null, if the time zone web service header should not be added.

Returns:

String or null

getWsi18nTimeZone

String getWsi18nTimeZone()

Return the Time zone String which should be used in web services header. Can return null, if the time zone web service header should not be added.
For further information see W3C definition of WS-i18n.

Returns:

String or null

init

void init(Map<String,String> arr_p)

Initial method which is called after instantiation of the Security handler. Provided are HTTP headers and also USERNAME and USERPASSWORD for simple authentication.

Parameters:

arr_p - Map Strings header to value mapping