net.officefloor.eclipse.wizard.access

Class HttpSecuritySourceInstance

java.lang.Object

net.officefloor.compile.impl.issues.AbstractCompilerIssues

net.officefloor.eclipse.wizard.access.HttpSecuritySourceInstance

All Implemented Interfaces:

CompilerIssues, HttpSecuritySourceExtensionContext

public class HttpSecuritySourceInstance
extends AbstractCompilerIssues
implements HttpSecuritySourceExtensionContext

HttpSecuritySource instance.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	createControls(org.eclipse.swt.widgets.Composite page) Creates the Control instances to populate the Property instances.
long	getAuthenticationTimeout() Obtains the authentication timeout.
String	getHttpSecuritySourceClassName() Obtains the fully qualified class name of the HttpSecuritySource.
String	getHttpSecuritySourceLabel() Obtains the label for the HttpSecuritySource.
HttpSecurityType<?,?,?,?>	getHttpSecurityType() Obtains the loaded HttpSecurityType.
org.eclipse.core.resources.IProject	getProject() Obtains the IProject that is adding the HttpSecuritySource.
PropertyList	getPropertyList() Obtains the PropertyList to configure the HttpSecuritySource.
protected void	handleDefaultIssue(DefaultCompilerIssue issue) Implement to handle DefaultCompilerIssue.
void	loadAccessInstance(AccessInstance accessInstance) Loads the particular AccessInstance for this HttpSecuritySourceInstance to configure properties from.
void	loadHttpSecurityType() Attempts to load the HttpSecurityType.
boolean	loadHttpSecurityType(CompilerIssues issues) Attempts to load the HttpSecurityType.
void	notifyPropertiesChanged() Notifies of a change to the PropertyList.
void	setAuthenticationTimeout(long authenticationTimeout) Specifies the authentication timeout.
void	setErrorMessage(String message) Specifies an error message.
void	setTitle(String title) Specifies the title.

Methods inherited from class net.officefloor.compile.impl.issues.AbstractCompilerIssues

addIssue, addIssue, captureIssues, createCompilerIssue, handleIssue

Methods inherited from class java.lang.Object

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

Method Detail

setAuthenticationTimeout

public void setAuthenticationTimeout(long authenticationTimeout)

Specifies the authentication timeout.

Parameters:

authenticationTimeout - Authentication timeout.

loadAccessInstance

public void loadAccessInstance(AccessInstance accessInstance)

Loads the particular AccessInstance for this HttpSecuritySourceInstance to configure properties from.

Parameters:

accessInstance - AccessInstance.

loadHttpSecurityType

public void loadHttpSecurityType()

Attempts to load the HttpSecurityType.

loadHttpSecurityType

public boolean loadHttpSecurityType(CompilerIssues issues)

Attempts to load the HttpSecurityType.

Parameters:

issues - CompilerIssues to be notified of issues in loading.

Returns:

true if loaded.

getHttpSecuritySourceLabel

public String getHttpSecuritySourceLabel()

Obtains the label for the HttpSecuritySource.

Returns:

Label for the HttpSecuritySource.

getHttpSecuritySourceClassName

public String getHttpSecuritySourceClassName()

Obtains the fully qualified class name of the HttpSecuritySource.

Returns:

HttpSecuritySource class name.

getAuthenticationTimeout

public long getAuthenticationTimeout()

Obtains the authentication timeout.

Returns:

Authentication timeout.

getPropertyList

public PropertyList getPropertyList()

Obtains the PropertyList to configure the HttpSecuritySource.

Specified by:

getPropertyList in interface HttpSecuritySourceExtensionContext

Returns:

Populated PropertyList.

getHttpSecurityType

public HttpSecurityType<?,?,?,?> getHttpSecurityType()

Obtains the loaded HttpSecurityType.

Returns:

Loaded HttpSecurityType or null if issue loading.

createControls

public void createControls(org.eclipse.swt.widgets.Composite page)

Creates the Control instances to populate the Property instances.

Parameters:

page - Composite to add Control instances.

setTitle

public void setTitle(String title)

Description copied from interface: HttpSecuritySourceExtensionContext

Specifies the title.

Specified by:

setTitle in interface HttpSecuritySourceExtensionContext

Parameters:

title - Title.

setErrorMessage

public void setErrorMessage(String message)

Description copied from interface: HttpSecuritySourceExtensionContext

Specifies an error message. Calling this after notifying of property changes allows for overriding the error message reported to the user.

Specified by:

setErrorMessage in interface HttpSecuritySourceExtensionContext

Parameters:

message - Error message. null indicating no error.

notifyPropertiesChanged

public void notifyPropertiesChanged()

Description copied from interface: HttpSecuritySourceExtensionContext

Notifies of a change to the PropertyList.

This allows for to report issues in attempting to source the HttpSecurityType from the HttpSecuritySource with the PropertyList.

Specified by:

notifyPropertiesChanged in interface HttpSecuritySourceExtensionContext

getProject

public org.eclipse.core.resources.IProject getProject()

Description copied from interface: HttpSecuritySourceExtensionContext

Obtains the IProject that is adding the HttpSecuritySource.

Specified by:

getProject in interface HttpSecuritySourceExtensionContext

Returns:

IProject that is adding the HttpSecuritySource.

handleDefaultIssue

protected void handleDefaultIssue(DefaultCompilerIssue issue)

Description copied from class: AbstractCompilerIssues

Implement to handle DefaultCompilerIssue.

Specified by:

handleDefaultIssue in class AbstractCompilerIssues

Parameters:

issue - DefaultCompilerIssue.