Package org.nuxeo.ecm.platform.ui.web.auth.service

Class LoginProviderLink

java.lang.Object

org.nuxeo.ecm.platform.ui.web.auth.service.LoginProviderLink

All Implemented Interfaces:

Descriptor

public class LoginProviderLink
extends Object
implements Descriptor

Since:

5.7

Author:

Tiry

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description
protected String	iconPath
protected String	label
protected String	link
protected String	name
protected boolean	remove
protected LoginProviderLinkComputer	urlComputer
protected Class<LoginProviderLinkComputer>	urlComputerClass

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
LoginProviderLink()
LoginProviderLink(String name, String iconPath, String link, String label, String description, LoginProviderLinkComputer urlComputer)

Method Summary

Modifier and Type	Method	Description
boolean	doesRemove()	During merge if a descriptor whose doesRemove() returns true is encountered, the merge chain is reset and started again on next descriptor.
boolean	equals(Object obj)
String	getDescription()
String	getIconPath()
String	getId()	The descriptor id, descriptors with same id are merged.
String	getLabel()
String	getLink()
String	getLink(jakarta.servlet.http.HttpServletRequest req, String requestedUrl)
String	getName()
LoginProviderLink	merge(Descriptor o)	Returns a descriptor representing other merged into this
void	setDescription(String description)
void	setIconPath(String iconPath)
void	setLink(String link)
void	setName(String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

copy, getCopyId

Field Details

name

protected String name

label

protected String label

remove

protected boolean remove

iconPath

protected String iconPath

link

protected String link

urlComputerClass

protected Class<LoginProviderLinkComputer> urlComputerClass

urlComputer

protected LoginProviderLinkComputer urlComputer

description

protected String description

Constructor Details

LoginProviderLink

public LoginProviderLink()

LoginProviderLink

public LoginProviderLink(String name,
 String iconPath,
 String link,
 String label,
 String description,
 LoginProviderLinkComputer urlComputer)

Since:

10.10

Method Details

getId

public String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overridden toString() for example.

Specified by:

getId in interface Descriptor

getName

public String getName()

setName

public void setName(String name)

getIconPath

public String getIconPath()

setIconPath

public void setIconPath(String iconPath)

getLink

public String getLink(jakarta.servlet.http.HttpServletRequest req,
 String requestedUrl)

setLink

public void setLink(String link)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getLabel

public String getLabel()

getLink

public String getLink()

merge

public LoginProviderLink merge(Descriptor o)

Description copied from interface: Descriptor

Returns a descriptor representing other merged into this

Default implementation returns other.

Specified by:

merge in interface Descriptor

Returns:

the merged descriptor

doesRemove

public boolean doesRemove()

Description copied from interface: Descriptor

During merge if a descriptor whose doesRemove() returns true is encountered, the merge chain is reset and started again on next descriptor.

If the last descriptor of same id doesRemove() return true, the descriptor for this id will be null.

Specified by:

doesRemove in interface Descriptor

equals

public boolean equals(Object obj)

Overrides:

equals in class Object