/** * Returns an existing record from the store, if one exists. * * @param context a storage context label * @param key a key unique to context * * @return the record read back, if present, or null * @throws IOException if errors occur in the read process */ @Nullable StorageRecord read(@Nonnull @NotEmpty final String context, @Nonnull @NotEmpty final String key) throws IOException;
/** * Constructor. * * @param protocolUri the SAML protocol */ public ProtocolCriterion(@Nonnull @NotEmpty final String protocolUri) { protocol = Constraint.isNotNull(StringSupport.trimOrNull(protocolUri), "SAML protocol URI cannot be null or empty"); }
/** * Get a modifiable collection of timer name / stop object pairs for the supplied * start object ID. * * @param objectId the object ID input * * @return the collection of associated mappings */ @Nonnull @NonnullElements @Live public Collection<Pair<String,String>> getTimerMappings( @Nonnull @NotEmpty final String objectId) { return timerMap.get(objectId); }
/** * Set the service principal name. Required. * * @param principal service principal */ public void setServicePrincipal(@Nonnull @NotEmpty final String principal) { ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this); servicePrincipal = Constraint.isNotEmpty(StringSupport.trim(principal), "Principal cannot be null or empty"); }
/** * Sets the HTTP response codes permitted for successful authentication of the proxy callback URL. * * @param responseCodes One or more HTTP response codes. */ public void setAllowedResponseCodes(@NotEmpty @NonnullElements final Set<Integer> responseCodes) { Constraint.isNotEmpty(responseCodes, "Response codes cannot be null or empty."); Constraint.noNullItems(responseCodes.toArray(), "Response codes cannot contain null elements."); allowedResponseCodes = responseCodes; }
/** * Constructor. * * @param entityId the entity ID, can not be null or empty */ public EntityIdCriterion(@Nonnull @NotEmpty final String entityId) { id = Constraint.isNotNull(StringSupport.trimOrNull(entityId), "Entity ID cannot be null or empty"); }
/** * Get a live collection of sessions associated with a service. * * @param id name of service to retrieve * * @return the sessions for the service */ @Nonnull @NonnullElements @Live public Collection<SPSession> getSessions(@Nonnull @NotEmpty final String id) { return sessionMap.get(id); }
/** * Updates the expiration time of all records in the context. * * @param context a storage context label * @param expiration a new expiration timestamp, or null * * @throws IOException if errors occur in the cleanup process */ void updateContextExpiration(@Nonnull @NotEmpty final String context, @Nullable final Long expiration) throws IOException;
/** * Set the digest algorithm for username hashing. * * @param alg digest algorithm */ public void setDigestAlgorithm(@Nonnull @NotEmpty final String alg) { digestAlgorithm = Constraint.isNotNull(StringSupport.trimOrNull(alg), "Digest algorithm cannot be null or empty"); }
/** * Get a live collection of values associated with a field. * * @param field field to retrieve * * @return the field's values */ @Nonnull @NonnullElements @Live public Collection<String> getFieldValues(@Nonnull @NotEmpty final String field) { return fieldMap.get(field); }
/** * Constructor. * * @param newName the entity group name */ public EntityGroupName(@Nonnull @NotEmpty final String newName) { name = Constraint.isNotNull(StringSupport.trimOrNull(newName), "Entity group name may not be null or empty"); }
/** * Constructor. * * @param responseLocationUri the binding response location URI */ public BindingResponseLocationCriterion(@Nonnull @NotEmpty final String responseLocationUri) { location = Constraint.isNotNull(StringSupport.trimOrNull(responseLocationUri), "Response location cannot be null or empty"); }
/** * Return the default security configuration for the profile. * * @param profileId the profile ID (available via * {@link net.shibboleth.idp.profile.config.ProfileConfiguration#getId()} * @return the configured default configuration */ @Nullable SecurityConfiguration getDefaultSecurityConfiguration(@Nonnull @NotEmpty final String profileId);
/** * Constructor. * * @param locationUri the binding location URI */ public BindingLocationCriterion(@Nonnull @NotEmpty final String locationUri) { location = Constraint.isNotNull(StringSupport.trimOrNull(locationUri), "Location cannot be null or empty"); }
/** * Set the attribute ID to check. * * @param id the attribute ID to check */ public void setAttributeId(@Nonnull @NotEmpty final String id) { attributeId = Constraint.isNotNull(StringSupport.trimOrNull(id), "Attribute ID cannot be null or empty"); }
/** * Constructor. * * @param entityId the entity ID, can not be null or empty */ public EntityIdCriterion(@Nonnull @NotEmpty final String entityId) { id = Constraint.isNotNull(StringSupport.trimOrNull(entityId), "Entity ID cannot be null or empty"); }