SystemLDAPConfiguration.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.security.ldap.configuration;

import aQute.bnd.annotation.metatype.Meta;

import com.liferay.portal.configuration.metatype.annotations.ExtendedObjectClassDefinition;

/**
 * @author Michael C. Han
 */
@ExtendedObjectClassDefinition(
	category = "foundation", factoryInstanceLabelAttribute = "companyId",
	scope = ExtendedObjectClassDefinition.Scope.COMPANY
)
@Meta.OCD(
	factory = true,
	id = "com.liferay.portal.security.ldap.configuration.SystemLDAPConfiguration",
	localization = "content/Language", name = "system.ldap.configuration.name"
)
public interface SystemLDAPConfiguration extends CompanyScopedConfiguration {

	@Meta.AD(deflt = "0", required = false)
	@Override
	public long companyId();

	@Meta.AD(deflt = "com.sun.jndi.ldap.LdapCtxFactory", required = false)
	public String factoryInitial();

	@Meta.AD(
		deflt = "follow", optionValues = {"follow", "ignore", "throws"},
		required = false
	)
	public String referral();

	@Meta.AD(deflt = "1000", description = "page-size-help", required = false)
	public int pageSize();

	@Meta.AD(deflt = "1000", description = "range-size-help", required = false)
	public int rangeSize();

	@Meta.AD(
		deflt = "com.sun.jndi.ldap.connect.pool=true|com.sun.jndi.ldap.connect.timeout=500|com.sun.jndi.ldap.read.timeout=15000",
		required = false
	)
	public String[] connectionProperties();

	@Meta.AD(deflt = "age", required = false)
	public String[] errorPasswordAgeKeywords();

	@Meta.AD(deflt = "expired", required = false)
	public String[] errorPasswordExpiredKeywords();

	@Meta.AD(deflt = "history", required = false)
	public String[] errorPasswordHistoryKeywords();

	@Meta.AD(deflt = "not allowed to change", required = false)
	public String[] errorPasswordNotChangeableKeywords();

	@Meta.AD(deflt = "syntax", required = false)
	public String[] errorPasswordSyntaxKeywords();

	@Meta.AD(deflt = "trivial", required = false)
	public String[] errorPasswordTrivialTextKeywords();

	@Meta.AD(deflt = "retry limit", required = false)
	public String[] errorUserLockoutKeywords();

}