[java-opensaml] branch master updated: OSJ-199: Warn on deprecated Methods and Classes
Brent Putman
putmanb at georgetown.edu
Fri Sep 28 00:24:29 EDT 2018
This is an automated email from the git hooks/post-receive script.
putmanb pushed a commit to branch master
in repository java-opensaml.
View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=8a5a55697167ee05b1a0f319defa3e61a4d31e80
The following commit(s) were added to refs/heads/master by this push:
new 8a5a556 OSJ-199: Warn on deprecated Methods and Classes
8a5a556 is described below
commit 8a5a55697167ee05b1a0f319defa3e61a4d31e80
Author: Brent Putman <putmanb at georgetown.edu>
AuthorDate: Fri Sep 28 00:10:18 2018 -0400
OSJ-199: Warn on deprecated Methods and Classes
---
.../main/java/org/opensaml/messaging/context/BaseContext.java | 6 ++++++
.../resolver/impl/AbstractDynamicHTTPMetadataResolver.java | 10 ++++++++++
.../metadata/resolver/impl/BasicRoleDescriptorResolver.java | 4 ++++
.../saml/metadata/resolver/impl/HTTPMetadataResolver.java | 9 +++++++++
.../org/opensaml/saml/saml1/core/impl/NameIdentifierImpl.java | 5 +++++
.../java/org/opensaml/xmlsec/encryption/support/Decrypter.java | 4 ++++
.../xmlsec/impl/BasicEncryptionParametersResolver.java | 4 ++++
7 files changed, 42 insertions(+)
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/BaseContext.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/BaseContext.java
index 6af8d87..c800228 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/BaseContext.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/BaseContext.java
@@ -28,6 +28,8 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElemen
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.collection.ClassIndexedSet;
import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
import org.opensaml.messaging.MessageRuntimeException;
import org.slf4j.Logger;
@@ -299,6 +301,8 @@ public abstract class BaseContext implements Iterable<BaseContext> {
*/
@Deprecated
public boolean isAutoCreateSubcontexts() {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".isAutoCreateSubcontexts",
+ null, "no replacement");
return autoCreateSubcontexts;
}
@@ -311,6 +315,8 @@ public abstract class BaseContext implements Iterable<BaseContext> {
*/
@Deprecated
public void setAutoCreateSubcontexts(final boolean autoCreate) {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setAutoCreateSubcontexts",
+ null, "no replacement");
autoCreateSubcontexts = autoCreate;
}
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
index ffe0802..3e9fb19 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
@@ -159,6 +159,8 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
* @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
*/
public void setTLSTrustEngine(@Nullable final TrustEngine<? super X509Credential> engine) {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setTLSTrustEngine",
+ null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
tlsTrustEngine = engine;
}
@@ -172,6 +174,8 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
public void setCredentialsProvider(@Nullable final CredentialsProvider provider) {
ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setCredentialsProvider",
+ null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
credentialsProvider = provider;
}
@@ -192,6 +196,8 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
* @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
*/
public void setBasicCredentials(@Nullable final UsernamePasswordCredentials credentials) {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setBasicCredentials",
+ null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
setBasicCredentialsWithScope(credentials, null);
}
@@ -216,6 +222,8 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
@Nullable final AuthScope scope) {
ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setBasicCredentialsWithScope",
+ null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
if (credentials != null) {
AuthScope authScope = scope;
@@ -398,6 +406,8 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
@Deprecated
protected void checkTLSCredentialTrusted(final HttpClientContext context, final HttpUriRequest request)
throws SSLPeerUnverifiedException {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".checkTLSCredentialTrusted",
+ null, "HttpClientSecuritySupport.checkTLSCredentialEvaluated(HttpClientContext, String)");
HttpClientSecuritySupport.checkTLSCredentialEvaluated(context, request.getURI().getScheme());
}
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/BasicRoleDescriptorResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/BasicRoleDescriptorResolver.java
index 418371c..9527161 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/BasicRoleDescriptorResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/BasicRoleDescriptorResolver.java
@@ -31,6 +31,8 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElemen
import net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent;
import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
import net.shibboleth.utilities.java.support.resolver.ResolverException;
@@ -74,6 +76,8 @@ public class BasicRoleDescriptorResolver extends AbstractIdentifiedInitializable
* @param mdResolver the resolver of EntityDescriptors
*/
public BasicRoleDescriptorResolver(@Nonnull final MetadataResolver mdResolver) {
+ DeprecationSupport.warnOnce(ObjectType.CLASS, getClass().getName(), null,
+ PredicateRoleDescriptorResolver.class.getName());
entityDescriptorResolver = Constraint.isNotNull(mdResolver, "Resolver for EntityDescriptors may not be null");
setId(UUID.randomUUID().toString());
}
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java
index cea9ef7..5c1dc59 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java
@@ -154,6 +154,8 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
* @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
*/
public void setTLSTrustEngine(@Nullable final TrustEngine<? super X509Credential> engine) {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setTLSTrustEngine",
+ null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
tlsTrustEngine = engine;
}
@@ -168,6 +170,8 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
* @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
*/
public void setBasicCredentials(@Nullable final UsernamePasswordCredentials credentials) {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setBasicCredentials",
+ null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
setBasicCredentialsWithScope(credentials, null);
}
@@ -189,6 +193,9 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
@Nullable final AuthScope scope) {
ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
+
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setBasicCredentialsWithScope",
+ null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
if (credentials != null) {
AuthScope authScope = scope;
@@ -334,6 +341,8 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
*/
@Deprecated
protected void checkTLSCredentialTrusted(final HttpClientContext context) throws SSLPeerUnverifiedException {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName()+ ".checkTLSCredentialTrusted",
+ null, "HttpClientSecuritySupport.checkTLSCredentialEvaluated(..)");
HttpClientSecuritySupport.checkTLSCredentialEvaluated(context, metadataURI.getScheme());
}
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/core/impl/NameIdentifierImpl.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/core/impl/NameIdentifierImpl.java
index 1e10a69..be24ec2 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/core/impl/NameIdentifierImpl.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/core/impl/NameIdentifierImpl.java
@@ -23,6 +23,9 @@ import org.opensaml.core.xml.XMLObject;
import org.opensaml.saml.common.AbstractSAMLObject;
import org.opensaml.saml.saml1.core.NameIdentifier;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
+
/**
* Complete implementation of {@link org.opensaml.saml.saml1.core.NameIdentifier}.
*/
@@ -62,6 +65,7 @@ public class NameIdentifierImpl extends AbstractSAMLObject implements NameIdenti
/** {@inheritDoc} */
@Deprecated
public String getNameIdentifier() {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".getNameIdentifier", null, "getValue");
return getValue();
}
@@ -83,6 +87,7 @@ public class NameIdentifierImpl extends AbstractSAMLObject implements NameIdenti
/** {@inheritDoc} */
@Deprecated
public void setNameIdentifier(final String id) {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setNameIdentifier", null, "setValue");
setValue(id);
}
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java
index 3d2152f..4faad3a 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java
@@ -33,6 +33,8 @@ import javax.xml.XMLConstants;
import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
import net.shibboleth.utilities.java.support.primitive.StringSupport;
import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
import net.shibboleth.utilities.java.support.resolver.Criterion;
@@ -986,6 +988,8 @@ public class Decrypter {
* @deprecated
*/
protected ParserPool buildParserPool() {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".buildParserPool()",
+ null, "no replacement (now obtained from global configuration)");
// Note: we don't really build this here anymore, so the method name is semantically misleading.
// We should remove this method in next major release and just move this call to the ctor.
return Constraint.isNotNull(ConfigurationService.get(DecryptionParserPool.class),
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java
index b618e35..c119b94 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java
@@ -49,6 +49,8 @@ import com.google.common.collect.Collections2;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport;
+import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.ObjectType;
import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
import net.shibboleth.utilities.java.support.resolver.ResolverException;
@@ -229,6 +231,8 @@ public class BasicEncryptionParametersResolver extends AbstractSecurityParameter
* @deprecated use {@link #validate(EncryptionParameters, boolean)}.
*/
protected boolean validate(@Nonnull final EncryptionParameters params) {
+ DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".validate(EncryptionParameters)",
+ null, "validate(EncryptionParameters, boolean)");
return validate(params, false);
}
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list