org.cloudfoundry.uaa.identityzones

Class Branding

java.lang.Object

org.cloudfoundry.uaa.identityzones.Branding

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class Branding
extends Object

The payload for the identity branding configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Branding.Builder Builds instances of type Branding.

Method Summary

Modifier and Type	Method and Description
static Branding.Builder	builder() Creates a builder for Branding.
boolean	equals(Object another) This instance is equal to all instances of Branding that have equal attribute values.
Banner	getBanner() The banner configuration
String	getCompanyName() This name is used on the UAA Pages and in account management related communication in UAA
Consent	getConsent() The consent configuration
String	getFooterLegalText() This text appears on the footer of all UAA pages
Map<String,String>	getFooterLinks() These links appear on the footer of all UAA pages.
String	getProductLogo() This is a base64Url encoded PNG image which will be used as the logo on all UAA pages like Login, Sign Up etc.
String	getSquareLogo() This is a base64 encoded PNG image which will be used as the favicon for the UAA pages
int	hashCode() Computes a hash code from attributes: banner, companyName, consent, footerLegalText, footerLinks, productLogo, squareLogo.
String	toString() Prints the immutable value Branding with attribute values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getBanner

public Banner getBanner()

The banner configuration

getCompanyName

public String getCompanyName()

This name is used on the UAA Pages and in account management related communication in UAA

getConsent

public Consent getConsent()

The consent configuration

getFooterLegalText

public String getFooterLegalText()

This text appears on the footer of all UAA pages

getFooterLinks

public Map<String,String> getFooterLinks()

These links appear on the footer of all UAA pages. You may choose to add multiple urls for things like Support, Terms of Service etc.

getProductLogo

public String getProductLogo()

This is a base64Url encoded PNG image which will be used as the logo on all UAA pages like Login, Sign Up etc.

getSquareLogo

public String getSquareLogo()

This is a base64 encoded PNG image which will be used as the favicon for the UAA pages

equals

public boolean equals(Object another)

This instance is equal to all instances of Branding that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: banner, companyName, consent, footerLegalText, footerLinks, productLogo, squareLogo.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Branding with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static Branding.Builder builder()

Creates a builder for Branding.

 Branding.builder()
    .banner(org.cloudfoundry.uaa.identityzones.Banner | null) // nullable banner
    .companyName(String | null) // nullable companyName
    .consent(org.cloudfoundry.uaa.identityzones.Consent | null) // nullable consent
    .footerLegalText(String | null) // nullable footerLegalText
    .footerLinks(Map<String, String> | null) // nullable footerLinks
    .productLogo(String | null) // nullable productLogo
    .squareLogo(String | null) // nullable squareLogo
    .build();
 

Returns:

A new Branding builder