Commit 3c615adb authored by cdanger's avatar cdanger

Fixed javadoc

parent ffe033e5
......@@ -58,12 +58,12 @@ public interface CloseableNamedAttributeProvider extends NamedAttributeProvider,
*
* @param attributeValueFactories
* AttributeValue factories for the Provider to be able to create AttributeValues
* @param depAttrProvider
* @param dependencyAttributeProvider
* Existing Attribute Provider supplying the possibly required attributes that new Providers instantiated here will depend on
*
* @return attribute value in internal model
*/
CloseableNamedAttributeProvider getInstance(AttributeValueFactoryRegistry attributeValueFactories, AttributeProvider depAttrProvider);
CloseableNamedAttributeProvider getInstance(AttributeValueFactoryRegistry attributeValueFactories, AttributeProvider dependencyAttributeProvider);
}
/**
......@@ -84,13 +84,13 @@ public interface CloseableNamedAttributeProvider extends NamedAttributeProvider,
/**
* Creates an attribute-dependency-aware AttributeProvider factory by inferring attribute dependencies (required attributes) from {@code conf}.
*
* @param conf
* @param configuration
* configuration, that may define what attributes are required (dependency attributes)
* @param environmentProperties
* global PDP configuration environment properties
* @return a factory aware of dependencies (required attributes) possibly inferred from input {@code conf}
*/
public abstract DependencyAwareFactory getInstance(CONF_T conf, EnvironmentProperties environmentProperties);
public abstract DependencyAwareFactory getInstance(CONF_T configuration, EnvironmentProperties environmentProperties);
}
}
......@@ -22,20 +22,17 @@ import java.util.Iterator;
import java.util.List;
import java.util.Optional;
import org.ow2.authzforce.xacml.identifiers.XacmlStatusCode;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.StatusCode;
import oasis.names.tc.xacml._3_0.core.schema.wd_17.StatusDetail;
import org.ow2.authzforce.xacml.identifiers.XacmlStatusCode;
/**
* Simplifies XACML Status handling.
*/
public class StatusHelper extends oasis.names.tc.xacml._3_0.core.schema.wd_17.Status
public final class StatusHelper extends oasis.names.tc.xacml._3_0.core.schema.wd_17.Status
{
/**
*
*/
private static final long serialVersionUID = 1L;
/**
......
......@@ -85,10 +85,10 @@ public interface RootPolicyProvider extends Closeable
*
* @return the root policy provider instance
* @throws IllegalArgumentException
* invalid {@code conf}
* invalid parameters
*/
public abstract RootPolicyProvider getInstance(ROOT_POLICY_PROVIDER_CONF conf, XmlnsFilteringParserFactory xacmlParserFactory, ExpressionFactory expressionFactory,
CombiningAlgRegistry combiningAlgRegistry, Optional<CloseableRefPolicyProvider> refPolicyProvider, EnvironmentProperties environmentProperties) throws IllegalArgumentException;
CombiningAlgRegistry combiningAlgRegistry, Optional<CloseableRefPolicyProvider> refPolicyProvider, EnvironmentProperties environmentProperties) throws IllegalArgumentException;
}
}
\ No newline at end of file
......@@ -33,7 +33,12 @@ import net.sf.saxon.s9api.XPathCompiler;
/**
* Registry of AttributeValue Factories supporting multiple datatypes. Any implementation of this must guarantee that there is a one-to-one relationship between AttributeValue (sub)classes and
* datatype URIs (AttributeValueType DataType field)
* datatype URIs (AttributeValueType DataType field).
*
* <p>
* A valid key in this registry, i.e. valid argument for {@link #getExtension(String)}, is an identifier of a datatype corresponding to the value factory, as returned by
* {@link AttributeValueFactory#getId()}
* </p>
*
*/
public interface AttributeValueFactoryRegistry extends PdpExtensionRegistry<AttributeValueFactory<?>>
......
......@@ -419,7 +419,7 @@ public final class Bags
}
/**
* Creates instance of immutable attribtue bag.
* Creates instance of immutable attribute bag.
*
* @param values
* bag values, typically a List for ordered results, e.g. attribute values for which order matters; or it may be a Set for result of bag/Set functions (intersection, union...)
......@@ -467,7 +467,8 @@ public final class Bags
}
/**
* Creates instance of immutable attribute bag with {@link AttributeSources#REQUEST} as attribute source.
* Creates instance of immutable attribute bag with {@link AttributeSources#REQUEST} as attribute source. Use {@link #newAttributeBag(Datatype, Collection, AttributeSource)} instead if attribute
* bag comes from another source, e.g. AttributeProvider.
*
* @param values
* bag values, typically a List for ordered results, e.g. attribute values for which order matters; or it may be a Set for result of bag/Set functions (intersection, union...)
......
......@@ -40,6 +40,9 @@ public abstract class BaseAttributeValueFactory<AV extends AttributeValue> imple
this.hashCode = this.instanceDatatype.hashCode();
}
/**
* Returns the ID of the Datatype of values created by this factory
*/
@Override
public final String getId()
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment