Browse Source
This is intended to replace the RefFilter interface (but does not yet, for backwards compatibility). That interface required lots of extra scanning and copying in filter cases such as only advertising a subtree of the refs directory. Instead, provide a hook that can be executed right before ref advertisement, using the public methods on UploadPack/ReceivePack to explicitly set the map of advertised refs. Change-Id: I0067019a191c8148af2cfb71a675f2258c5af0castable-2.0
Dave Borowitz
13 years ago
committed by
Shawn O. Pearce
11 changed files with 479 additions and 93 deletions
@ -0,0 +1,105 @@ |
|||||||
|
/* |
||||||
|
* Copyright (C) 2012, Google Inc. |
||||||
|
* and other copyright owners as documented in the project's IP log. |
||||||
|
* * This program and the accompanying materials are made available |
||||||
|
* under the terms of the Eclipse Distribution License v1.0 which |
||||||
|
* accompanies this distribution, is reproduced below, and is |
||||||
|
* available at http://www.eclipse.org/org/documents/edl-v10.php
|
||||||
|
* |
||||||
|
* All rights reserved. |
||||||
|
* |
||||||
|
* Redistribution and use in source and binary forms, with or |
||||||
|
* without modification, are permitted provided that the following |
||||||
|
* conditions are met: |
||||||
|
* |
||||||
|
* - Redistributions of source code must retain the above copyright |
||||||
|
* notice, this list of conditions and the following disclaimer. |
||||||
|
* |
||||||
|
* - Redistributions in binary form must reproduce the above |
||||||
|
* copyright notice, this list of conditions and the following |
||||||
|
* disclaimer in the documentation and/or other materials provided |
||||||
|
* with the distribution. |
||||||
|
* |
||||||
|
* - Neither the name of the Eclipse Foundation, Inc. nor the |
||||||
|
* names of its contributors may be used to endorse or promote |
||||||
|
* products derived from this software without specific prior |
||||||
|
* written permission. |
||||||
|
* |
||||||
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
||||||
|
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
||||||
|
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
||||||
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
||||||
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
||||||
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||||
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
||||||
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
||||||
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
||||||
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
||||||
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
||||||
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
||||||
|
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||||
|
*/ |
||||||
|
|
||||||
|
package org.eclipse.jgit.transport; |
||||||
|
|
||||||
|
import java.util.Map; |
||||||
|
import java.util.Set; |
||||||
|
|
||||||
|
import org.eclipse.jgit.lib.ObjectId; |
||||||
|
import org.eclipse.jgit.lib.Ref; |
||||||
|
import org.eclipse.jgit.lib.Repository; |
||||||
|
import org.eclipse.jgit.revwalk.RevWalk; |
||||||
|
|
||||||
|
/** |
||||||
|
* Implementation of {@link AdvertiseRefsHook} that advertises the same refs for |
||||||
|
* upload-pack and receive-pack. |
||||||
|
*/ |
||||||
|
public abstract class AbstractAdvertiseRefsHook implements AdvertiseRefsHook { |
||||||
|
public void advertiseRefs(UploadPack uploadPack) |
||||||
|
throws ServiceMayNotContinueException { |
||||||
|
uploadPack.setAdvertisedRefs(getAdvertisedRefs( |
||||||
|
uploadPack.getRepository(), uploadPack.getRevWalk())); |
||||||
|
} |
||||||
|
|
||||||
|
public void advertiseRefs(ReceivePack receivePack) |
||||||
|
throws ServiceMayNotContinueException { |
||||||
|
Map<String, Ref> refs = getAdvertisedRefs(receivePack.getRepository(), |
||||||
|
receivePack.getRevWalk()); |
||||||
|
Set<ObjectId> haves = getAdvertisedHaves(receivePack.getRepository(), |
||||||
|
receivePack.getRevWalk()); |
||||||
|
receivePack.setAdvertisedRefs(refs, haves); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Get the refs to advertise. |
||||||
|
* |
||||||
|
* @param repository |
||||||
|
* repository instance. |
||||||
|
* @param revWalk |
||||||
|
* open rev walk on the repository. |
||||||
|
* @return set of refs to advertise. |
||||||
|
* @throws ServiceMayNotContinueException |
||||||
|
* abort; the message will be sent to the user. |
||||||
|
*/ |
||||||
|
protected abstract Map<String, Ref> getAdvertisedRefs( |
||||||
|
Repository repository, RevWalk revWalk) |
||||||
|
throws ServiceMayNotContinueException; |
||||||
|
|
||||||
|
/** |
||||||
|
* Get the additional haves to advertise. |
||||||
|
* |
||||||
|
* @param repository |
||||||
|
* repository instance. |
||||||
|
* @param revWalk |
||||||
|
* open rev walk on the repository. |
||||||
|
* @return set of additional haves; see |
||||||
|
* {@link ReceivePack#getAdvertisedObjects()}. |
||||||
|
* @throws ServiceMayNotContinueException |
||||||
|
* abort; the message will be sent to the user. |
||||||
|
*/ |
||||||
|
protected Set<ObjectId> getAdvertisedHaves( |
||||||
|
Repository repository, RevWalk revWalk) |
||||||
|
throws ServiceMayNotContinueException { |
||||||
|
return null; |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,87 @@ |
|||||||
|
/* |
||||||
|
* Copyright (C) 2012, Google Inc. |
||||||
|
* and other copyright owners as documented in the project's IP log. |
||||||
|
* * This program and the accompanying materials are made available |
||||||
|
* under the terms of the Eclipse Distribution License v1.0 which |
||||||
|
* accompanies this distribution, is reproduced below, and is |
||||||
|
* available at http://www.eclipse.org/org/documents/edl-v10.php
|
||||||
|
* |
||||||
|
* All rights reserved. |
||||||
|
* |
||||||
|
* Redistribution and use in source and binary forms, with or |
||||||
|
* without modification, are permitted provided that the following |
||||||
|
* conditions are met: |
||||||
|
* |
||||||
|
* - Redistributions of source code must retain the above copyright |
||||||
|
* notice, this list of conditions and the following disclaimer. |
||||||
|
* |
||||||
|
* - Redistributions in binary form must reproduce the above |
||||||
|
* copyright notice, this list of conditions and the following |
||||||
|
* disclaimer in the documentation and/or other materials provided |
||||||
|
* with the distribution. |
||||||
|
* |
||||||
|
* - Neither the name of the Eclipse Foundation, Inc. nor the |
||||||
|
* names of its contributors may be used to endorse or promote |
||||||
|
* products derived from this software without specific prior |
||||||
|
* written permission. |
||||||
|
* |
||||||
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
||||||
|
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
||||||
|
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
||||||
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
||||||
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
||||||
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||||
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
||||||
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
||||||
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
||||||
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
||||||
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
||||||
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
||||||
|
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||||
|
*/ |
||||||
|
|
||||||
|
package org.eclipse.jgit.transport; |
||||||
|
|
||||||
|
/** Hook to allow callers to take over advertising refs to the client. */ |
||||||
|
public interface AdvertiseRefsHook { |
||||||
|
/** |
||||||
|
* A simple hook that advertises the default refs. |
||||||
|
* <p> |
||||||
|
* The method implementations do nothing to preserve the default behavior; see |
||||||
|
* {@link UploadPack#setAdvertisedRefs(java.util.Map)} and |
||||||
|
* {@link ReceivePack#setAdvertisedRefs(java.util.Map,java.util.Set)}. |
||||||
|
*/ |
||||||
|
public static final AdvertiseRefsHook DEFAULT = new AdvertiseRefsHook() { |
||||||
|
public void advertiseRefs(UploadPack uploadPack) { |
||||||
|
// Do nothing.
|
||||||
|
} |
||||||
|
|
||||||
|
public void advertiseRefs(ReceivePack receivePack) { |
||||||
|
// Do nothing.
|
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
/** |
||||||
|
* Advertise refs for upload-pack. |
||||||
|
* |
||||||
|
* @param uploadPack instance on which to call |
||||||
|
* {@link UploadPack#setAdvertisedRefs(java.util.Map)} |
||||||
|
* if necessary. |
||||||
|
* @throws ServiceMayNotContinueException |
||||||
|
* abort; the message will be sent to the user. |
||||||
|
*/ |
||||||
|
public void advertiseRefs(UploadPack uploadPack) |
||||||
|
throws ServiceMayNotContinueException; |
||||||
|
|
||||||
|
/** |
||||||
|
* Advertise refs for receive-pack. |
||||||
|
* |
||||||
|
* @param receivePack instance on which to call |
||||||
|
* {@link ReceivePack#setAdvertisedRefs(java.util.Map,java.util.Set)} |
||||||
|
* if necessary. |
||||||
|
* @throws ServiceMayNotContinueException |
||||||
|
* abort; the message will be sent to the user. |
||||||
|
*/ |
||||||
|
public void advertiseRefs(ReceivePack receivePack) |
||||||
|
throws ServiceMayNotContinueException; |
||||||
|
} |
||||||
@ -0,0 +1,77 @@ |
|||||||
|
/* |
||||||
|
* Copyright (C) 2011-2012, Google Inc. |
||||||
|
* and other copyright owners as documented in the project's IP log. |
||||||
|
* |
||||||
|
* This program and the accompanying materials are made available |
||||||
|
* under the terms of the Eclipse Distribution License v1.0 which |
||||||
|
* accompanies this distribution, is reproduced below, and is |
||||||
|
* available at http://www.eclipse.org/org/documents/edl-v10.php
|
||||||
|
* |
||||||
|
* All rights reserved. |
||||||
|
* |
||||||
|
* Redistribution and use in source and binary forms, with or |
||||||
|
* without modification, are permitted provided that the following |
||||||
|
* conditions are met: |
||||||
|
* |
||||||
|
* - Redistributions of source code must retain the above copyright |
||||||
|
* notice, this list of conditions and the following disclaimer. |
||||||
|
* |
||||||
|
* - Redistributions in binary form must reproduce the above |
||||||
|
* copyright notice, this list of conditions and the following |
||||||
|
* disclaimer in the documentation and/or other materials provided |
||||||
|
* with the distribution. |
||||||
|
* |
||||||
|
* - Neither the name of the Eclipse Foundation, Inc. nor the |
||||||
|
* names of its contributors may be used to endorse or promote |
||||||
|
* products derived from this software without specific prior |
||||||
|
* written permission. |
||||||
|
* |
||||||
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
||||||
|
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
||||||
|
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
||||||
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
||||||
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
||||||
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||||
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
||||||
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
||||||
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
||||||
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
||||||
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
||||||
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
||||||
|
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||||
|
*/ |
||||||
|
|
||||||
|
package org.eclipse.jgit.transport; |
||||||
|
|
||||||
|
import java.io.IOException; |
||||||
|
|
||||||
|
/** Indicates a transport service may not continue execution. */ |
||||||
|
public class ServiceMayNotContinueException extends IOException { |
||||||
|
private static final long serialVersionUID = 1L; |
||||||
|
|
||||||
|
private boolean output; |
||||||
|
|
||||||
|
/** Initialize with no message. */ |
||||||
|
public ServiceMayNotContinueException() { |
||||||
|
// Do not set a message.
|
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* @param msg |
||||||
|
* a message explaining why it cannot continue. This message may |
||||||
|
* be shown to an end-user. |
||||||
|
*/ |
||||||
|
public ServiceMayNotContinueException(String msg) { |
||||||
|
super(msg); |
||||||
|
} |
||||||
|
|
||||||
|
/** @return true if the message was already output to the client. */ |
||||||
|
public boolean isOutput() { |
||||||
|
return output; |
||||||
|
} |
||||||
|
|
||||||
|
/** Mark this message has being sent to the client. */ |
||||||
|
public void setOutput() { |
||||||
|
output = true; |
||||||
|
} |
||||||
|
} |
||||||
Loading…
Reference in new issue