Package jetbrains.buildServer.serverSide.auth

Class AuthModuleTypeAdapter

java.lang.Object

jetbrains.buildServer.serverSide.auth.AuthModuleTypeAdapter

All Implemented Interfaces:

AuthModuleType

Direct Known Subclasses:

HttpAuthenticationSchemeAdapter, LoginModuleDescriptorAdapter

public abstract class AuthModuleTypeAdapter
extends Object
implements AuthModuleType

Adapter for AuthModuleType

Since:

8.0

Constructor Summary

Constructors

Constructor	Description
AuthModuleTypeAdapter()

Method Summary

Modifier and Type	Method	Description
String	describeProperties(Map<String,String> properties)	Returns description of the specified properties map to be shown in UI
Map<String,String>	getDefaultProperties()
String	getDescription()	Returns description of the authentication module to show in the UI
String	getDisplayName()	Returns name of the authentication module to show in the UI
String	getEditPropertiesJspFilePath()
boolean	isMultipleInstancesAllowed()

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.buildServer.serverSide.auth.AuthModuleType

getName, validate

Constructor Detail

AuthModuleTypeAdapter

public AuthModuleTypeAdapter()

Method Detail

getDisplayName

@NotNull
public String getDisplayName()

Description copied from interface: AuthModuleType

Returns name of the authentication module to show in the UI

Specified by:

getDisplayName in interface AuthModuleType

Returns:

name of the authentication module to show in the UI

getDescription

@NotNull
public String getDescription()

Description copied from interface: AuthModuleType

Returns description of the authentication module to show in the UI

Specified by:

getDescription in interface AuthModuleType

Returns:

description of the authentication module to show in the UI

isMultipleInstancesAllowed

public boolean isMultipleInstancesAllowed()

Specified by:

isMultipleInstancesAllowed in interface AuthModuleType

Returns:

true, if multiple instances of this authentication module are allowed, false otherwise

getDefaultProperties

@NotNull
public Map<String,String> getDefaultProperties()

Specified by:

getDefaultProperties in interface AuthModuleType

Returns:

default properties for this authentication module

getEditPropertiesJspFilePath

@Nullable
public String getEditPropertiesJspFilePath()

Specified by:

getEditPropertiesJspFilePath in interface AuthModuleType

Returns:

path to JSP file to edit properties of this authentication module or null if authentication module has no properties

describeProperties

@NotNull
public String describeProperties(@NotNull
                                 Map<String,String> properties)

Description copied from interface: AuthModuleType

Returns description of the specified properties map to be shown in UI

Specified by:

describeProperties in interface AuthModuleType

Parameters:

properties - properties

Returns:

description of the specified properties map